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
Grid.GetProperties
OverviewExamples
table Grid.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a grid object.
P arame t er s
ObjectName
(string) The name of the grid object.
Re t u r n s
(table) A table containing the grid object's properties, indexed by the following keys:
|
KEY |
TYPE DESCRIPTION |
|
|
ObjectName |
string |
The name of the grid object. |
|
Rows |
number |
The number of rows in the grid object. |
|
Columns |
number |
The number of columns in the grid object. |
|
FixedRows |
number |
The number of fixed rows in the grid object. |
|
FixedColumns |
number |
The number of fixed columns in the grid object. |
|
TextColor |
number |
The color value of the text. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
TextBackgroundColor |
number |
The color value of the background. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
FixedTextColor |
number |
The color value of fixed text. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
FixedBackgroundColor |
number |
The color value of the fixed background. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
GridLineColor |
number |
The color value of the grid's lines. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
GridBackgroundColor |
number |
The color value of the grid's background. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
TitleTipBackgroundColor |
number |
The color value of the grid tooltip's background. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
TitleTipTextColor |
number |
The color value of the grid tooltip's text. If this value is GRID_CLR_DEFAULT (4278190080) then it is set to the default color according to the user's Windows color scheme. |
|
Editable |
boolean |
True if the grid is editable by the user, or false if it is not. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
FW_DONTCARE |
0 |
Font weight not specified. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
GVL_NONE |
0 |
None. |
|
GVL_HORZ |
1 |
Horizontal lines. |
|
GVL_VERT |
2 |
Vertical lines. |
|
GVL_BOTH |
3 |
Both. |
|
Selectable |
boolean |
True if the user can select grid cells with the mouse or keyboard, or false if they cannot. |
|
CellDragAndDrop |
boolean |
True if cells can be dragged and dropped by the user, or false if they cannot. |
|
ResizableRows |
boolean |
True if rows can be resized by the user, or false if they cannot. |
|
ResizableColumns |
boolean |
True if columns can be resized by the user, or false if they cannot. |
|
GridLines |
number |
A number that tells you which grid lines are displayed in the grid: |
|
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_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 in use by the grid 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. |
||||
|
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. |
|
Enabled |
boolean |
True if the grid object is enabled, false if it is not. |
|
Visible |
boolean |
True if the grid object is visible, false if it is not. |
|
X |
number |
The horizontal position (in pixels) of the top left corner of the grid 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 grid 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 grid object. |
|
Height |
number |
The height (in pixels) of the grid object. |
|
TooltipText |
string |
The mouseover tooltip of the grid 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.