OverviewExamples
table Button.GetProperties ( |
Returns a table containing the properties of a button object.
(string) The name of the button object.
(table) A table containing the button's properties, indexed by the following keys:
KEY |
TYPE |
DESCRIPTION | |||||||||||||||||||||||||||||||||||||||||||||
ButtonFile |
string |
The currently loaded .btn file. | |||||||||||||||||||||||||||||||||||||||||||||
Text |
string |
The text displayed on the button object. | |||||||||||||||||||||||||||||||||||||||||||||
ObjectName |
string |
The name of the button 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 button object:
| |||||||||||||||||||||||||||||||||||||||||||||
XOffset |
number |
The horizontal offset of the text with respect to the button object. | |||||||||||||||||||||||||||||||||||||||||||||
YOffset |
number |
The vertical offset of the text with respect to the button object. | |||||||||||||||||||||||||||||||||||||||||||||
LeftMargin |
number |
The size of the left margin (in pixels) to leave around the text. | |||||||||||||||||||||||||||||||||||||||||||||
RightMargin |
number |
The size of the right margin (in pixels) to leave around the text. | |||||||||||||||||||||||||||||||||||||||||||||
Alignment |
number |
The text alignment:
| |||||||||||||||||||||||||||||||||||||||||||||
Style |
number |
The style of the button object:
| |||||||||||||||||||||||||||||||||||||||||||||
ToggleState |
number |
The current state of the button object.
| |||||||||||||||||||||||||||||||||||||||||||||
ColorNormal |
number |
The 'normal' color of the button's text. | |||||||||||||||||||||||||||||||||||||||||||||
ColorHighlight |
number |
The 'highlight' color of the button's text. | |||||||||||||||||||||||||||||||||||||||||||||
ColorDisabled |
number |
The 'disabled' color of the button's text. | |||||||||||||||||||||||||||||||||||||||||||||
ColorDown |
number |
The 'down' color of the button's text. | |||||||||||||||||||||||||||||||||||||||||||||
Enabled |
boolean |
True if the button object is enabled, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the button object is visible, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the button 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 button 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 button object. | |||||||||||||||||||||||||||||||||||||||||||||
Height |
number |
The height (in pixels) of the button object. | |||||||||||||||||||||||||||||||||||||||||||||
TooltipText |
string |
The mouseover tooltip of the button object. | |||||||||||||||||||||||||||||||||||||||||||||
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the button object:
| |||||||||||||||||||||||||||||||||||||||||||||
ResizeLeft |
boolean |
True if the left side of the object will move when the application is resized, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
ResizeRight |
boolean |
True if the right side of the object will move when the application is resized, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
ResizeTop |
boolean |
True if the top of the object will move when the application is resized, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
ResizeBottom |
boolean |
True if the bottom of the object will move when the application is resized, false if it is not. | |||||||||||||||||||||||||||||||||||||||||||||
HighlightSound |
number |
The type of sound that will be played when the mouse moves over the button object.
| |||||||||||||||||||||||||||||||||||||||||||||
HighlightSoundFile |
string |
The path to the button object's custom highlight sound file. If the button 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 button object.
| |||||||||||||||||||||||||||||||||||||||||||||
ClickSoundFile |
string |
The path to the button object's custom click sound file. If the button 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