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
Input.GetProperties
OverviewExamples
table Input.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of an input object.
P arame t er s
ObjectName
(string) The name of the input object.
Re t u r n s
|
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'. |
(table) A table containing the input object's properties, indexed by the following keys:
|
KEY |
TYPE DESCRIPTION |
|
|
Text |
string |
The text displayed in the input object. |
|
ObjectName |
string |
The name of the input 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): |
|
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 in use by the input 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 |
||||
|
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. |
||||
|
CONSTANT |
VALUE DESCRIPTION |
|
|
MASK_FORMATTED |
0 |
Return the text as it is formatted by the mask: 555-5555 |
|
MASK_AS_TYPED |
1 |
Return just the text without formatting: 5555555 |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
INPUT_STANDARD |
0 |
A standard input object. |
|
INPUT_PASSWORD |
1 |
Any text in the input object is hidden: ******. |
|
INPUT_MASK |
2 |
The text has a specific structure (e.g. ###- ####) |
|
SYMBOL_CHARSET |
2 |
Symbol character set. |
|
TURKISH_CHARSET |
162 |
Turkish character set. |
|
FontColor |
number |
The color of the font used in the input object. |
|
Multiline |
boolean |
True if multi-line support is enabled, false if it is not. |
|
VScrollbar |
boolean |
True if vertical scrollbars are enabled, false if they are not. |
|
HScrollbar |
boolean |
True if horizontal scrollbars are enabled, false if they are not. |
|
InputStyle |
number |
The type of input object: |
|
MaskText |
string |
The input mask used if InputStyle is set to INPUT_MASK. |
|
MaskReturnMode |
number |
How text from an input object will be returned using an Input.GetText action: |
|
Placeholder |
string |
A placeholder character used as 'filler' in an input object with an input mask. |
|
Border |
number |
The type of border surrounding the input object: |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
ALIGN_LEFT |
0 |
Text is left aligned. |
|
ALIGN_CENTER |
1 |
Text is center aligned. |
|
ALIGN_RIGHT |
2 |
Text is right aligned. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
READ_STANDARD |
0 |
Display the characters left to right. |
|
READ_RIGHT_TO_LEFT |
1 |
Display the characters right to left. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
BORDER_NONE |
0 |
No border. |
|
BORDER_FLAT |
1 |
'Flat', single line border. |
|
BORDER_SUNKEN |
2 |
Sunken border. |
|
ReadOrder |
number |
How text will be displayed in the input object: |
|
|
BackgroundColor |
number |
The color of the input object background. |
|
|
ReadOnly |
boolean |
True if the input object is read-only, false if it is not. |
|
|
Alignment |
number |
The text alignment in the input object: |
|
|
Enabled |
boolean |
True if the input object is enabled, false if it is not. |
|
|
Visible |
boolean |
True if the input object is visible, false if it is not. |
|
|
X |
number |
The horizontal position (in pixels) of the top left corner of the input 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 input 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 input object. |
|
|
Height |
number |
The height (in pixels) of the input object. |
|
|
TooltipText |
string |
The mouseover tooltip of the input 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. |
|
|
WindowHandle |
number |
The integer value that represents the object's window. (Commonly referred to as an hWnd.) |
|
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.