Label.SetProperties

Label.SetProperties (

string ObjectName,

table Properties )

Description

Sets the properties of a label object.

Parameters

ObjectName

(string) The name of the label object.

Properties

(table) A table containing the label object's properties indexed by the following keys:

KEY

TYPE

DESCRIPTION

Text

string

The text to be displayed in the label object.

FontName

string

The font name.

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontSize

number

The font size (in points).

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontStrikeout

boolean

True if the font should be set to strikeout, false if it should not be.

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontUnderline

boolean

True if the font should be set to underline, false if it should not be.

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontAntiAlias

boolean

True if the font should be set to anti alias, false if it should not be.

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontItalic

boolean

True if the font should be set to italic, false if it should not be.

Note: If this value is specified, any values passed for Height or Width will be ignored.

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'.

Note: If this value is specified, any values passed for Height or Width will be ignored.

FontScript

number

The character set in use by the label 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.

Note: If this value is specified, any values passed for Height or Width will be ignored.

Alignment

number

The alignment of the text in the label object. Choose from:

CONSTANT

VALUE

DESCRIPTION

ALIGN_LEFT

0

Text is left aligned.

ALIGN_CENTER

1

Text is center aligned.

ALIGN_RIGHT

2

Text is right aligned.

Orientation

number

The orientation of the label object with relation to the page or dialog:

VALUE

DESCRIPTION

0

Label object is 'normal'.

90

Rotated 90 degrees counter-clockwise.

180

Rotated 180 degrees counter-clockwise.

270

Rotated 270 degrees counter-clockwise.

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 should be enabled, false if it should not be.

Visible

boolean

True if the label object should be visible, false if it should not be.

X

number

The horizontal position (in pixels) of the top left corner of the label 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 label 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 label object.

Note: The label object will be resized so its width is as close as possible to this value while maintaining a whole number for its font size. If this value is specified, any value passed for Width will be ignored.

Tip: To adjust both font-related properties as well as the width of a label object, use two separate actions.

Height

number

The height (in pixels) of the label object.

Note: The label object will be resized so its height is as close as possible to this value while maintaining a whole number for its font size. If a value is specified for Width, the Height value will be ignored.

Tip: To adjust both font-related properties as well as the height of a label object, use two separate actions.

TooltipText

string

The mouseover tooltip of the label object. Tip: If you want a "&" character in the text, you must enter "&&&".

Cursor

number

The mouse cursor that should be displayed when the mouse is over the label 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 should be played when the mouse moves over the label 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 label object's custom highlight sound file.

ClickSound

number

The type of sound that should be played when the mouse clicks the label 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 label object's custom click sound file.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also: Related Actions