OverviewExamples
Button.SetProperties ( |
Sets the properties of a button object.
(string) The name of the button object.
(table) A table containing the button object's properties indexed by the following keys:
KEY |
TYPE |
DESCRIPTION | |||||||||||||||||||||||||||||||||||||||||||||
ButtonFile |
string |
The button file to load. | |||||||||||||||||||||||||||||||||||||||||||||
Text |
string |
The text to display on the button object. | |||||||||||||||||||||||||||||||||||||||||||||
FontName |
string |
The font name. | |||||||||||||||||||||||||||||||||||||||||||||
FontSize |
number |
The font size (in points). | |||||||||||||||||||||||||||||||||||||||||||||
FontStrikeout |
boolean |
True if the font should be set to strikeout, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
FontUnderline |
boolean |
True if the font should be set to underline, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
FontAntiAlias |
boolean |
True if the font should be set to anti alias, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
FontItalic |
boolean |
True if the font should be set to italic, false if it should not be.. | |||||||||||||||||||||||||||||||||||||||||||||
FontWeight |
number |
The weight of the font (how 'dark' the text will appear):
| |||||||||||||||||||||||||||||||||||||||||||||
FontScript |
number |
The character set to use in 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 should be enabled, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the button object should be visible, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
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. Tip: If you want a "&" character in the text, you must enter "&&&". | |||||||||||||||||||||||||||||||||||||||||||||
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 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 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 (""). Note: For this to take effect, HighlightSound must be set to SND_CUSTOM. | |||||||||||||||||||||||||||||||||||||||||||||
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 (""). Note: For this to take effect, ClickSound must be set to SND_CUSTOM. |
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions