Button.SetProperties

Button.SetProperties (

string ObjectName,

table Properties )

Parameters

ObjectName

(string) The name of the button object.

Properties

(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):

CONSTANT	VALUE	DESCRIPTION
FW_DONTCARE	0	Font weight not specified.
FW_THIN	100	Font weight 'thin'.
FW_EXTRALIGHT	200	Font weight 'extra-light'.
FW_LIGHT	300	Font weight 'light'.
FW_NORMAL	400	Font weight 'normal'.
FW_MEDIUM	500	Font weight 'medium'.
FW_SEMIBOLD	600	Font weight 'semi-bold'.
FW_BOLD	700	Font weight 'bold'.
FW_EXTRABOLD	800	Font weight 'extra bold'.
FW_HEAVY	900	Font weight 'heavy'.

FontScript

number

The character set to use in the button object:

CONSTANT	VALUE	DESCRIPTION
ANSI_CHARSET	0	ANSI character set.
BALTIC_CHARSET	186	Baltic character set.
CHINESEBIG5_CHARSET	136	Chinese character set.
DEFAULT_CHARSET	1	Default character set.
EASTEUROPE_CHARSET	238	Eastern European character set.
GB2312_CHARSET	134	GB2312 character set.
GREEK_CHARSET	161	Greek character set.
HANGUL_CHARSET	129	Hangul character set.
MAC_CHARSET	77	MAC character set.
OEM_CHARSET	255	OEM character set.
RUSSIAN_CHARSET	204	Russian character set.
SHIFTJIS_CHARSET	128	Shiftjis character set.
SYMBOL_CHARSET	2	Symbol character set.
TURKISH_CHARSET	162	Turkish character set.

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:

CONSTANT	VALUE	DESCRIPTION
ALIGN_LEFT	0	Text is left aligned.
ALIGN_CENTER	1	Text is center aligned.
ALIGN_RIGHT	2	Text is right aligned.

Style

number

The style of the button object:

CONSTANT	VALUE	DESCRIPTION
BTNSTYLE_STANDARD	0	Button is a standard button.
BTNSTYLE_TOGGLE	1	Button is a toggle button.

ToggleState

number

The current state of the button object.

CONSTANT	VALUE	DESCRIPTION
BTN_UP	0	Button is in its up state.
BTN_DOWN	1	Button is in its down state.

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.

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

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:

CONSTANT	VALUE	DESCRIPTION
CURSOR_ARROW	0	Standard mouse arrow cursor.
CURSOR_HAND	1	Hand cursor.
CURSOR_BLACK_ARROW	2	Black arrow cursor.
CURSOR_CROSSHAIR	3	Crosshair cursor.
CURSOR_EXPLORE	4	Explore cursor.
CURSOR_HELP	5	Help cursor.
CURSOR_MAGNIFY	6	Magnify cursor.
CURSOR_MEDIA	7	Media cursor.
CURSOR_MONEY	8	Money cursor.
CURSOR_NOTEPAD	9	Notepad cursor.
CURSOR_PENCIL	10	Pencil cursor.
CURSOR_PRINTER	11	Printer cursor.
CURSOR_SPEAKER	12	Speaker cursor.
CURSOR_UP_ARROW	13	Up arrow cursor.

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.

CONSTANT	VALUE	DESCRIPTION
SND_NONE	0	No highlight sound.
SND_STANDARD	1	Standard highlight sound.
SND_CUSTOM	2	Custom highlight sound.

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.

CONSTANT	VALUE	DESCRIPTION
SND_NONE	0	No click sound.
SND_STANDARD	1	Standard click sound.
SND_CUSTOM	2	Custom click sound.

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.

Description

Parameters

ObjectName

Properties

Returns