CollapseGroup Action (Explorer Controls)

Applies to TestComplete 14.80, last modified on April 21, 2021
This method is not supported in web tests (including cross-platform web tests) that use XPath expressions and CSS selectors to locate web elements. This method can be only used in tests that locate web objects by using internal identification properties provided by TestComplete.

Description

The CollapseGroup action collapses the specified control's group. The effect is the same as if you clicked the "-" button of the group. 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    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 parameter:

Group

Specifies the caption or zero-based index of the desired group.

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 group is already collapsed, the CollapseGroup action performs no action and posts an informative message to the test log.

If the specified group is not found, the CollapseGroup action fails and posts an error message to the test log.

The script recorder recognizes mouse clicks on the “-” buttons within the items' labels and records the CollapseGroup command.

See Also

ExpandGroup Action (Explorer Controls)

Highlight search results