ResultVariable
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
Label.GetProperties
OverviewExamples
table Label.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a label object.
P arame t er s
ObjectName
(string) The name of the label object.
Re t u r n s
(table) A table containing the label object's properties, indexed by the following keys: KEY TYPE DESCRIPTION
|
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'. |
|
Text |
string |
The text displayed in the label object. |
|
ObjectName |
string |
The name of the label 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 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. |
|
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. |
||||
|
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. |
|
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: |
|
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 is enabled, false if it is not. |
|
Visible |
boolean |
True if the label object is visible, false if it is not. |
|
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. |
|
Height |
number |
The height (in pixels) of 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. |
|
TooltipText |
string |
The mouseover tooltip of the label object. |
|
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the label 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 label object. |
|
HighlightSoundFile |
string |
The path to the label object's custom highlight sound file. If the label 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 label object. |
|
ClickSoundFile |
string |
The path to the label object's custom click sound file. If the label object does not use a custom sound, this value will be an empty string (""). |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No highlight sound. |
|
SND_STANDARD |
1 |
Standard highlight sound. |
|
SND_CUSTOM |
2 |
Custom highlight sound. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No click sound. |
|
SND_STANDARD |
1 |
Standard click sound. |
|
SND_CUSTOM |
2 |
Custom click sound. |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.