OverviewExamples
Label.SetProperties ( |
Sets the properties of a label object.
(string) The name of the label object.
(table) A table containing the label object's properties indexed by the following keys:
KEY |
TYPE |
DESCRIPTION |
|||||||||||||||||||||||||||||||||||||||||||||
Text |
string |
The text to be displayed in the label object. |
|||||||||||||||||||||||||||||||||||||||||||||
FontName |
string |
The font name. Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontSize |
number |
The font size (in points). Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontStrikeout |
boolean |
True if the font should be set to strikeout, false if it should not be. Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontUnderline |
boolean |
True if the font should be set to underline, false if it should not be. Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontAntiAlias |
boolean |
True if the font should be set to anti alias, false if it should not be. Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontItalic |
boolean |
True if the font should be set to italic, false if it should not be. Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontWeight |
number |
The weight of the font (how 'dark' the text will appear):
Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
FontScript |
number |
The character set in use by the label object:
Note: If this value is specified, any values passed for Height or Width will be ignored. |
|||||||||||||||||||||||||||||||||||||||||||||
Alignment |
number |
The alignment of the text in the label object. Choose from:
|
|||||||||||||||||||||||||||||||||||||||||||||
Orientation |
number |
The orientation of the label object with relation to the page or dialog:
|
|||||||||||||||||||||||||||||||||||||||||||||
ColorNormal |
number |
The 'normal' color of the label object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorHighlight |
number |
The 'highlight' color of the label object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorDisabled |
number |
The 'disabled' color of the label object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorDown |
number |
The 'down' color of the label object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
Enabled |
boolean |
True if the label object should be enabled, false if it should not be. |
|||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the label object should be visible, false if it should not be. |
|||||||||||||||||||||||||||||||||||||||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the label object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has an X value of 0 |
|||||||||||||||||||||||||||||||||||||||||||||
Y |
number |
The vertical position (in pixels) of the top left corner of the label object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has a Y value of 0 |
|||||||||||||||||||||||||||||||||||||||||||||
Width |
number |
The width (in pixels) of the label object. Note: The label object will be resized so its width is as close as possible to this value while maintaining a whole number for its font size. If this value is specified, any value passed for Width will be ignored. Tip: To adjust both font-related properties as well as the width of a label object, use two separate actions. |
|||||||||||||||||||||||||||||||||||||||||||||
Height |
number |
The height (in pixels) of the label object. Note: The label object will be resized so its height is as close as possible to this value while maintaining a whole number for its font size. If a value is specified for Width, the Height value will be ignored. Tip: To adjust both font-related properties as well as the height of a label object, use two separate actions. |
|||||||||||||||||||||||||||||||||||||||||||||
TooltipText |
string |
The mouseover tooltip of the label object. Tip: If you want a "&" character in the text, you must enter "&&&". |
|||||||||||||||||||||||||||||||||||||||||||||
Cursor |
number |
The mouse cursor that should be displayed when the mouse is over the label object:
|
|||||||||||||||||||||||||||||||||||||||||||||
ResizeLeft |
boolean |
True if the left side of the object should move when the application is resized, false if it should not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeRight |
boolean |
True if the right side of the object should move when the application is resized, false if it should not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeTop |
boolean |
True if the top of the object should move when the application is resized, false if it should not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeBottom |
boolean |
True if the bottom of the object should move when the application is resized, false if it should not. |
|||||||||||||||||||||||||||||||||||||||||||||
HighlightSound |
number |
The type of sound that should be played when the mouse moves over the label object.
|
|||||||||||||||||||||||||||||||||||||||||||||
HighlightSoundFile |
string |
The path to the label object's custom highlight sound file. |
|||||||||||||||||||||||||||||||||||||||||||||
ClickSound |
number |
The type of sound that should be played when the mouse clicks the label object.
|
|||||||||||||||||||||||||||||||||||||||||||||
ClickSoundFile |
string |
The path to the label object's custom click sound file. |
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions