OverviewExamples
table Input.GetProperties ( |
Returns a table containing the properties of an input object.
(string) The name of the input object.
(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):
| |||||||||||||||||||||||||||||||||||||||||||||
FontScript |
number |
The character set in use by the input object:
| |||||||||||||||||||||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||||||||||||||||||||
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. Note: The top left corner of the current page 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. Note: The top left corner of the current page 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. | |||||||||||||||||||||||||||||||||||||||||||||
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.
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