Collapse action collapses the specified grid group. The effect is the same as when you click the “-” button of the group. However, the CollapseGroup action does not move the mouse cursor.
|TestObj||A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section|
|View||[in]||Optional||Variant||Default value: 0|
The method is applied to the following objects:
To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.
The method has the following parameters:
Specifies the zero-based index of the desired group. The first group has index 0, the second - 1, and so on. Index of the last row is
wRowCount - 1.
Specifies the grid view that contains the group. You can enter the view’s zero-based index or its caption.
The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to a string of any length (including an empty string), the question mark corresponds to any single character (including none). 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 default value of the View parameter is 0 and corresponds to the leftmost view in the current grid level.
If the specified group is not found,
CollapseGroup fails and posts an error message to the log.
The script recorder recognizes mouse clicks on the “-” buttons within the control groups and records the
To view an example that demonstrates how to use the
CollapseGroup action, see Expanding and Collapsing Rows in Developer Express QuantumGrid.