All settings mentioned in this class, need a prefix. This prefix is explained in the documentation of the module that uses this class.
Examples:
xTaskbarActiveButton...
MyLabel...
xPopupFolder...
- [ ]
- Values between [ and ] are optional
- BOOL
- Boolean value (
true
or false
)
- COLOR
- Color in Hex (FFFFFF = White, 000000 = Black, …)
- INT
- A number
- STRING
- A word, usually beginning with a period (.) or a quoted text
- FontAddToGroup STRING [STRING] [STRING] […]
- The parameters are:
(group-name1)
(group-name2)
(group-name3)
…
- Adds the xPaintHTMLText to the specified group.
- Please don't use this as normal AddToGroup, this is a special setting only very few themers will ever need.
- Overrides the module internal AddToGroup, if available.
- Only the first group has full support for adding itself to another group. The other groups do not. So (group-name2)AddToGroup SomeGroup will not work as expected.
- FontVisible BOOL
- If you set this value to
false
, you can prevent the text from being painted.
- FontAlign STRING
- STRING can be
.left
, .center
or .right
.
- Sets the horizontal text alignment.
- If no value is provided, then the default is
.center
.
- FontVertAlign STRING
- STRING can be
.top
, .center
or .bottom
.
- Sets the vertical text alignment.
- If no value is provided, then the default is
.center
.
- FontBorders INT INT INT INT
- FontBorders INT INT
- FontBorders INT
- Accepts 4, 2 or 1 INT value(s), which define the borders.
- The values provided are either Left Right Top Bottom, Left/Right Top/Bottom, or Left/Right/Top/Bottom.
- If no value is provided, then the default is 0.
- FontLeftBorder INT
- Sets the number of pixels on the left edge to reserve as a border.
- If no value is provided, then the default is 0.
- FontRightBorder INT
- Sets the number of pixels on the right edge to reserve as a border.
- If no value is provided, then the default is 0.
- FontTopBorder INT
- Sets the number of pixels on the top edge to reserve as a border.
- If no value is provided, then the default is 0.
- FontBottomBorder INT
- Sets the number of pixels on the bottom edge to reserve as a border.
- If no value is provided, then the default is 0.
- FontRotation INT
- The parameter is
degrees
- Rotates the text
degrees
degrees.
-
degrees
can take values from -360 to 360.
- Minimum Requirement: xPaintClass-1.0 Update 4.
- Font STRING
- Sets the name of the font used to display text.
- If no value is provided, then the default is "Arial".
- FontCharSet STRING
- Sets the CharSet to use with the current font (mostly important for eastern fonts).
- The following CharSets are possible:
DEFAULT_CHARSET
ANSI_CHARSET
BALTIC_CHARSET
CHINESEBIG5_CHARSET
EASTEUROPE_CHARSET
GB2312_CHARSET
GREEK_CHARSET
HANGUL_CHARSET
MAC_CHARSET
RUSSIAN_CHARSET
SHIFTJIS_CHARSET
SYMBOL_CHARSET
TURKISH_CHARSET
VIETNAMESE_CHARSET
JOHAB_CHARSET
ARABIC_CHARSET
HEBREW_CHARSET
THAI_CHARSET
OEM_CHARSET
- FontHeight INT
- Sets the height of the font used to display the text in pixels.
- If no value is provided, then the default is 15.
- FontColor COLOR
- Sets the color of the font used to display the text.
- If no value is provided, then the default is "000000".
- FontBold BOOL
- If this command is present the font will be bold.
- FontItalic BOOL
- If this command is present the font will be italic.
- FontUnderline BOOL
- If this command is present the font will be underlined.
- FontShadow BOOL
- If this command is present the font will be shadowed.
- FontShadowX INT
- Sets the number of pixels in the horizontal direction that the shadow is offset from the rest of the text, this can be negative.
- If no value is provided, then the default is 1.
- FontShadowY INT
- Sets the number of pixels in the vertical direction that the shadow is offset from the rest of the text, this can be negative.
- If no value is provided, then the default is 1.
- FontShadowBlocked INT
- The font is drawn like a "Block" with the specified height, use together with the
FontShadowColor
.
- FontShadowColor COLOR
- Sets the color used to display the text shadow.
- If no value is provided, then the default is dark gray (#808080).
- FontOutline BOOL
- If this command is present it makes a special shadow, an 1 pixel outline around the whole letter.
- You cannot have a normal shadow together with an outline!
- FontOutlineExtra BOOL
- If this command is present the outline is painted fully around the text, otherwise it's painted only at the 4 sides.
- That's just a minor visual difference, but now you can choose, which one is more your taste.
- FontOutlineColor COLOR
- Sets the color used to display the text outline.
- If no value is provided, then the default is dark gray (#808080).
- FontEmbossColor1 COLOR
- You can emboss the text or create only an outlined text (transparent inside).
- Single color (Color1) defined: Looks like an outline (both parts have the same color)
- FontEmbossColor2 COLOR
- You can emboss the text or create only an outlined text (transparent inside).
- Two colors (Color1 and Color2) defined: Depending on the Font, Background and choosen colors it looks like an embossed text.
- FontSmoothing BOOL
- If this command is set to
false
, then font smoothing is deactivated.
- The default is
true
, font smoothing is enabled.
- FontClearType BOOL
- If this command is set to
false
, then cleartype font smoothing is deactivated.
- The default is
true
, cleartype font smoothing is enabled.
- FontNoEllipsis BOOL
- If this command is present the text that is too long will NOT be cropped and replaced with "…".
- FontNewLineSpace INT
- Adjusts the spacing between lines. Positive (or negative) values are allowed.
- Default: 0
- FontAutoLineBreak BOOL
- If this command is present the text wraps automatically.
- FontAlphaTransparency INT
- Makes the font alphatransparent.
- Valid values are 0-255, where 0 is totally transparent and 255 is opaque.
- Default is 255.
- OS requirement: Windows 2000 or newer
- FontTextFade INT INT INT INT
- FontTextFade INT INT
- FontTextFade INT
- Accepts 4, 2 or 1 INT value(s), which define the number of pixels on which the text fades out at the sides. The values provided are either Left Right Top Bottom, Left/Right Top/Bottom, or Left/Right/Top/Bottom.
- OS requirement: Windows 2000 or newer
- FontLeftTextFade INT
- Sets the number of pixels on which the text fades out at the left edge.
- If no value is provided, then the default is 0.
- OS requirement: Windows 2000 or newer
- FontRightTextFade INT
- Sets the number of pixels on which the text fades out at right edge.
- If no value is provided, then the default is 0.
- OS requirement: Windows 2000 or newer
- FontTopTextFade INT
- Sets the number of pixels on which the text fades out at the top edge.
- If no value is provided, then the default is 0.
- OS requirement: Windows 2000 or newer
- FontBottomTextFade INT
- Sets the number of pixels on which the text fades out at the bottom edge.
- If no value is provided, then the default is 0.
- OS requirement: Windows 2000 or newer
- <strong>Text</strong>
- <b>Text</b>
- If the text is enclosed with this, then the text will be bold.
- <em>Text</em>
- <i>Text</i>
- If the text is enclosed with this, then the text will be italic.
- <u>Text</u>
- If the text is enclosed with this, then the text will be underlined.
- <center>Text</center>
- If the text is enclosed with this, then the text will be centered.
- <br>
- Newline/Linebreak
- <p>Text</p>
- Makes a paragraph (Newline with vertical space).
- <p align=left>Text</p>
- Makes an paragraph in which the text is left aligned.
- <p align=right>Text</p>
- Makes an paragraph in which the text is right aligned.
- <p align=center>Text</p>
- Makes an paragraph in which the text is centered.
- <font>Text</font>
- <font face=fontname>Text</font>
- If the text is enclosed with this, this font is used to display the text.
- <font size=Pixel>Text</font>
- If the text is enclosed with this, this
FontHeight
is used to display the text.
- The
FontHeight
you specify with FontHeight
(Default: 15) is default.
- <font color=#hexcode>Text</font>
- If the text is enclosed with this, this color is used to display the text.
- <font shadowcolor=#hexcode>Text</font>
- <font outlinecolor=#hexcode>Text</font>
- If the text is enclosed with this, this
FontShadowColor
/FontOutlineColor
is used to display the text.
- FontShadow/FontOutline must be enabled for this to work.
- <a href='action' title='tooltip'>Text</a>
- "Text" will be a clickable link with the optional "title" as tooltip, which will execute "action", if clicked.
- "action" can be any valid action LiteStep can perform (Bangs, filepath,…) OR a Url!
- Attention:
- Four important points that must always be taken care of:
xLabel is currently the only module that supports clickable HREF's.
The action
and title
must be quoted with a single-quote (').
If the action
is a url, the url must start with "http:" and must be quoted with a single-quote (').
If the action
needs quotes somewhere in it (for a path with spaces for example) you must use """ as an escape sequence for double-quotes (").
You can combine different font settings:
<font face=Tahoma size=12 color=#aa0000>Text</font>
Escape sequence | Output |
" | " |
< | < |
> | > |
> | > |
& | & |
%~ | ; |
[semicolon] | ; |
(Yes, there are two escape sequences for ;)