Description

The 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.

Declaration

TestObj.CollapseGroup(Group)

TestObj	A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Group	[in]	Required	Integer
Result	None

Applies To

The method is applied to the following objects:

AngularUI Grid, Developer Express WPF Grid, Developer Express XtraGrid and 7 more objects, DevExpressXtraGridView, Syncfusion Essential Grid (GridGroupingControl), SyncfusionEssGridView, Telerik RadGridView for Silverlight, Telerik RadGridView for WinForms, Xceed Grid, XceedDotNetGridGroup « Collapse the list

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:

Group

The index of the desired group, relative to the table or group in which it resides. The index is zero-based, that is, the first group has index 0, the second - 1, and so on. Index of the last group is wGroupCount - 1.

Result Value

None.

Remarks

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 CollapseGroup command.

Example

To view an example that demonstrates how to use the CollapseGroup action, see Expanding and Collapsing Rows in Syncfusion GridGroupingControl.

CollapseGroup Action (Grid Controls)