Collapse Action (Specific to DevExpressXtraVerticalGrid Controls)

Description

The Collapse action collapses the specified grid column. The effect is the same as when you click the “-” button of the column. However, the Collapse action does not move the mouse cursor.

Declaration

Applies To

The method is applied to the following objects:

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameter:

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.

XtraVerticalGrid:

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:

Result Value

None.

Remarks

If the specified column is not found, Collapse fails and posts an error message to the log.

The script recorder recognizes mouse clicks on the “-” buttons within the columns and records the Collapse command.

See Also

Expand Action (Specific to DevExpressXtraVerticalGrid Controls)