Description
Depending on the Expand parameter, the Expand
action expands or collapses the specified column. The effect is the same as when you click the “+” (or “-”) button of the column. However, the Expand
action does not move the mouse cursor.
Declaration
TestObj.Expand(Column, Expand)
TestObj | A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section | |||
Column | [in] | Required | Integer | |
Expand | [in] | Optional | Boolean | Default value: True |
Result | None |
Applies To
The method is applied to the following objects:
View Mode
This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.
Parameters
The method has the following parameters:
Column
Specifies the caption or index of the desired grid column.
The index is zero-based and corresponds to the column’s position within the object's internal columns collection rather than the column’s visible position in the object.
The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to a string of any length, the question mark corresponds to any single character. To specify more complicated parts of a caption, use regular expressions.
The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.
The XtraVerticalGrid control may contain multi-editor columns. These columns contain several headers (or nested columns) within each column. TestComplete considers these nested columns as ordinary columns, and both types of columns share the same index space. The following image illustrates a typical structure of the XtraVerticalGrid control: |
Expand
Specifies whether to expand or collapse the column.
Result Value
None.
Remarks
If the specified column is not found, Expand
fails and posts an error message to the log.
The script recorder recognizes mouse clicks on the “+” buttons within the grid columns and records the Expand
command.
To collapse the column, you can either call the Collapse
action or call Expand
with the Expand parameter set to False.
See Also
Collapse Action (Specific to DevExpressXtraVerticalGrid Controls)