OverviewExamples
table Label.GetProperties ( |
Returns a table containing 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 displayed in the label object. | |||||||||||||||||||||||||||||||||||||||||||||
ObjectName |
string |
The name of the label object. | |||||||||||||||||||||||||||||||||||||||||||||
FontName |
string |
The font name. | |||||||||||||||||||||||||||||||||||||||||||||
FontSize |
number |
The font size (in points). | |||||||||||||||||||||||||||||||||||||||||||||
FontStrikeout |
boolean |
True if the font is set to strikeout, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
FontUnderline |
boolean |
True if the font is set to underline, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
FontAntiAlias |
boolean |
True if the font is set to anti alias, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
FontItalic |
boolean |
True if the font is set to italic, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
FontWeight |
number |
The weight of the font (how 'dark' the text will appear):
| |||||||||||||||||||||||||||||||||||||||||||||
FontScript |
number |
The character set in use by the label object:
| |||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||
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 is enabled, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the label object is visible, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the label object in relation to the current page. Note: The top left corner of the current page 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. Note: The top left corner of the current page has a Y value of 0 | |||||||||||||||||||||||||||||||||||||||||||||
Width |
number |
The width (in pixels) of the label object. | |||||||||||||||||||||||||||||||||||||||||||||
Height |
number |
The height (in pixels) of the label object. | |||||||||||||||||||||||||||||||||||||||||||||
TooltipText |
string |
The mouseover tooltip of the label object. | |||||||||||||||||||||||||||||||||||||||||||||
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the label object:
| |||||||||||||||||||||||||||||||||||||||||||||
HighlightSound |
number |
The type of sound that will be played when the mouse moves over the label object.
| |||||||||||||||||||||||||||||||||||||||||||||
HighlightSoundFile |
string |
The path to the label object's custom highlight sound file. If the label object does not use a custom sound, this value will be an empty string (""). | |||||||||||||||||||||||||||||||||||||||||||||
ClickSound |
number |
The type of sound that will be played when the mouse clicks the label object.
| |||||||||||||||||||||||||||||||||||||||||||||
ClickSoundFile |
string |
The path to the label object's custom click sound file. If the label object does not use a custom sound, this value will be an empty string (""). |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions