Skip to content

Text

Jump to bottom
khanhas edited this page Jul 15, 2018 · 18 revisions

Parameters:

Text String

Add String to current canvas.

Image = Text I am A String

Modifiers:

Align

Default: LeftTop
Parameter:

Align Alignment

Horizontal and vertical alignment of the string within the meter. Valid values are:

  • LeftTop (or Left),
  • LeftCenter,
  • LeftBottom,
  • RightTop (or Right),
  • RightCenter,
  • RightBottom,
  • CenterTop (or Center),
  • CenterCenter,
  • CenterBottom

AntiAlias

Default: 1
Set to 0 to turn off edge smoothing.

BackgroundColor

Default: 0,0,0,0
Parameter:

BackgroundColor ColorValue

Text undercolor box. Check out Color formats.

Canvas

Parameters:

Canvas Width, Height

Define text region. Any pixel exceeds this region is cutoff.

Image = Text Example String 1 | Canvas 800,400`  
Image2 = Text Example String 2 | Canvas #CurrentConfigWidth#,([HeaderHeight] * 2)

Case

Default: None
Parameter:

Case CaseType

Valid CaseType value:

  • None
  • Upper
  • Lower
  • Proper

ClipStringH

Default: 0
Parameter:

ClipStringH Height

Sets a maximum height for text. String that overflows this height is clipped and an ellipsis is added at the end.
Note: No matter how small ClipStringH value is, text always maintain at least 1 line.
Example:

Image = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | Face Bahnschrift | Size 40
Image2 = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | ClipStringH 150 | Face Bahnschrift | Size 40 | Offset 550,0

ClipstringHDemo

ClipStringLine

Default: 0
Parameter:

ClipStringLine Lines

Sets a maximum line for text.
This modifiers works the same as ClipStringH. It clips text quickly basing on number of lines, so you do not have to calculate total lines height for ClipStringH.
Note: If ClipStringH and ClipStringLine are both set, ClipStringH clips the text first then ClipStringLine are applied.

Example:

Image = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | Face Bahnschrift | Size 40
Image2 = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | ClipStringLine 3 | Face Bahnschrift | Size 40 | Offset 550,0
Image3 = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | ClipStringLine 2 | Face Bahnschrift | Size 40 | Offset 1100,0

ClipstringLineDemo

ClipStringW

Default: 0
Parameter:

ClipStringW Width

Sets a maximum width for text. String that overflows this width is put in new line.
Example:

Image  = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | Face Bahnschrift | Size 40
Image2 = Text The Triumph of Cleopatra is an oil painting by English artist William Etty. | ClipStringW 500 | Face Bahnschrift | Size 40 | Offset 0,100

ClipstringWDemo

Color

Default: 255,255,255
Parameter:

Color ColorValue

Text color. Check out Color formats.

Color 180,0,50
Color 65,255,30,(255 * #Time# / 60)
Color 5050ff

Face

Default: Arial
Parameter:

Face FontName/@FontFileName/FontPath

Use a font for your string. It can be:

  • Installed font family name.
Image = Text Me Me | Face Comic Sans Ms | ...
  • Font file in YourSkinFolder\@Resources\Fonts folder.
Image = Text Big | Face @Avantgarde.ttf | ...
  • Direct link to font file. Not recommend for publishing skin.
Image = Text Boy | Face F:\FontCollection\Elegant Lux Mager.otf | ...

LineSpacing

Parameter:

LineSpacing Value

Text inter-line spacing.

Example:

Image = Text Entoloma#CRLF#Sinuatum | Face Bahnschrift | Size 40
Image2 = Text Entoloma#CRLF#Sinuatum | LineSpacing 30 | Face Bahnschrift | Size 40 | Offset 400,0
Image3 = Text Entoloma#CRLF#Sinuatum | LineSpacing -30 | Face Bahnschrift | Size 40 | Offset 800,0

LinspacingDemo

Offset

Default: 0,0
Parameters:

Offset OffsetX, OffsetY

Change text position.

Size

Default: 30
Parameter:

Size Value

Text size.

Image = Text String 1 | Size 80
Image2 = Text String 2 | Size (20*#Scale#)

Skew

Default: 0,0
Parameter:

Skew SkewX, SkewY

Skew to use in X or Y axis when annotating with text or drawing.

StrokeColor

Default: 0,0,0
Parameter:

StrokeColor ColorValue

Define stroke color. Check out Color formats.

StrokeWidth

Default: 0
Parameter:

StrokeWidth Width

Define stroke width.

Style

Default: Normal
Choose font style. Valid values:

  • Normal
  • Italic
  • Olique

Eg: Style Italic

TextKerning

Parameter:

TextKerning Value

Text inter-character kerning.
Example:

Image  = Text Xeromphalina setulipes | Face Bahnschrift | Size 40
Image2 = Text Xeromphalina setulipes | TextKerning 5 | Face Bahnschrift | Size 40  | Offset 0,100
Image3 = Text Xeromphalina setulipes | TextKerning -5 | Face Bahnschrift | Size 40 | Offset 0,200

TextKerningDemo

Weight

Default: 400
Choose font weight, only available for installed fonts. Valid values:

  • 100 - Thin (Hairline)
  • 200 - Extra Light (Ultra Light)
  • 300 - Light
  • 400 - Regular (Normal)
  • 500 - Medium
  • 600 - Semi Bold (Demi Bold)
  • 700 - Bold
  • 800 - Extra Bold (Ultra Bold)
  • 900 - Black (Heavy)
  • 950 - Extra Black (Ultra Black)

Eg: Weight 600

WordSpacing

Parameter:

WordSpacing Value

Text inter-word spacing.
Example:

Image = Text The Beagle is a breed of small hound that is similar in appearance | Face Bahnschrift | Size 40
Image2 = Text The Beagle is a breed of small hound that is similar in appearance | WordSpacing 20 | Face Bahnschrift | Size 40  | Offset 0,100
Image3 = Text The Beagle is a breed of small hound that is similar in appearance | WordSpacing -20 | Face Bahnschrift | Size 40 | Offset 0,200

WordspacingDemo

Clone this wiki locally