OverviewExamples
xButton.SetProperties ( |
Sets the properties of an xButton object.
(string) The name of the xButton object.
(table) A table containing the xButton object's properties indexed by the following keys:
KEY |
TYPE |
DESCRIPTION | |||||||||||||||||||||||||||||||||||||||||||||
Text |
string |
The text to display on the xButton object. | |||||||||||||||||||||||||||||||||||||||||||||
ButtonImage |
string |
The path to the image file to display on the xButton object. The xButton supports the following image formats: .bmp, .jpg, .png, .wmf, .gif and .ico (icon). | |||||||||||||||||||||||||||||||||||||||||||||
TextColor |
number |
The color of the text. | |||||||||||||||||||||||||||||||||||||||||||||
EnableMarkup |
boolean |
True if text markup should be enabled, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
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 by the xButton object:
| |||||||||||||||||||||||||||||||||||||||||||||
TextAlignment |
number |
The text alignment to use:
| |||||||||||||||||||||||||||||||||||||||||||||
ImageAlignment |
number |
The image alignment to use:
| |||||||||||||||||||||||||||||||||||||||||||||
ImageTextRelation |
number |
The relationship between the text and image:
| |||||||||||||||||||||||||||||||||||||||||||||
Theme |
number |
The visual theme of the xButton:
| |||||||||||||||||||||||||||||||||||||||||||||
Style |
number |
The style of the xButton object:
| |||||||||||||||||||||||||||||||||||||||||||||
ToggleState |
number |
The current toggle state of the xButton object.
| |||||||||||||||||||||||||||||||||||||||||||||
Enabled |
boolean |
True if the xButton object should be enabled, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the xButton object should be visible, false if it should not be. | |||||||||||||||||||||||||||||||||||||||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the xButton 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 xButton 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 xButton object. | |||||||||||||||||||||||||||||||||||||||||||||
Height |
number |
The height (in pixels) of the xButton object. | |||||||||||||||||||||||||||||||||||||||||||||
TooltipText |
string |
The mouseover tooltip of the xButton object. | |||||||||||||||||||||||||||||||||||||||||||||
Cursor |
number |
The mouse cursor to display when the mouse is over the xButton 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 to play when the mouse moves over the xButton object.
| |||||||||||||||||||||||||||||||||||||||||||||
HighlightSoundFile |
string |
The path to the xButton object's custom highlight sound file. If the xButton object does not use a custom sound, this value will be an empty string (""). | |||||||||||||||||||||||||||||||||||||||||||||
ClickSound |
number |
The type of sound to play when the mouse clicks the xButton object.
| |||||||||||||||||||||||||||||||||||||||||||||
ClickSoundFile |
string |
The path to the xButton object's custom click sound file. If the xButton object does not use a custom sound, this value will be an empty string (""). |
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions