Description
The Collapse action collapses the specified grid item. The effect is the same as when you click the item’s “-” button within the item’s label. You can also expand grid items by double-clicking on them (see DblClickLabel). Unlike DblClickLabel, the Collapse action does not move the mouse cursor.
Declaration
TestObj.Collapse(Item)
| TestObj | A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section | |||
| Item | [in] | Required | Variant | |
| Result | None | |||
Applies To
The method is applied to the following objects:
Developer Express PropertyGridControl, MFC PropertyGrid, Microsoft PropertyGrid, PropertyGridControlItem
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:
Item
Specifies the index or caption of the desired item whose label needs to be clicked.
The index is zero-based, that is, the index of the first item is 0. The index of the last item is wItemCount - 1.
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 item is not found, Collapse fails and posts an error message to the test log.
To collapse an item, you can also call the Expand action with the Expand parameter set to False, or use the DblClickLabel action.
The script recorder recognizes mouse clicks on the “-” buttons within the items’ labels and records the Collapse command.
Example
To view an example that demonstrates how to use the Collapse action, see Expanding and Collapsing Items in Microsoft PropertyGrid.
See Also
Expand Action (Specific to PropertyGrid Controls)
wExpanded Property (Specific to PropertyGrid Controls)