Description
The CollapseChildView action collapses the specified child table. The effect is the same as if you clicked the “-” button in the table caption. However, the CollapseChildView action does not move the mouse cursor.
Declaration
TestObj.CollapseChildView(Row, View)
| TestObj | A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section | |||
| Row | [in] | Required | Integer | |
| View | [in] | Required | Variant | |
| Result | None | |||
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 parameters:
Row
Specifies the index of the parent row of the desired table. The index is zero-based and is relative to the table or group in which the row resides. The first row has index 0, the second - 1, and so on. The index of the last row is wRowCount - 1.
View
Specifies the child table that will be collapsed. You can enter the tables’s zero-based index or 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.
Result Value
None.
Remarks
If the specified child table is not found, CollapseChildView fails and posts an error message to the log.
The script recorder recognizes mouse clicks on the “-” buttons in captions of GridGroupingControl tables and records the CollapseChildView command.
Example
To view an example that demonstrates how to use the CollapseChildView action, see Expanding and Collapsing Rows in Syncfusion GridGroupingControl.
See Also
ExpandChildView Action (Specific to SyncfusionEssGrid Controls)