CollapseItem Action (TreeView Controls)

Applies to TestComplete 15.63, last modified on April 10, 2024
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.


The CollapseItem action collapses the tree view item specified by the Item parameter. The effect is the same as if you would click the “-” button of the expanded node. Note however, that the CollapseItem 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
Item [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.


The method has the following parameter:


Specifies the path to the desired item. The path should be relative to the current item or to the tree root, respectively. To indicate that the path starts from the tree root, place the pipeline character ( | ) at the beginning of the path.

Each item in the path can be specified by its caption or index; individual captions and indexes must be separated with pipeline characters ( | ). Indexes must be enclosed in brackets - [ and ].

To indicate variable parts of the item caption, you can use the asterisk (*) and question mark (?) wildcards. The asterisk corresponds to a string of any length, the question mark corresponds to any single character. The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Note: If the item caption includes a bracket or a pipeline character, address the item by its index or with the question mark wildcard.

Result Value



If the specified item is not found, CollapseItem fails and posts an error message to the test log.

The script recorder recognizes clicks on the “-” buttons within the tree view control and records the CollapseItem command.


To view an example that demonstrates how to use the CollapseItem action, see Expanding and Collapsing Tree View Items in Desktop Windows Applications.

See Also

ExpandItem Action (Specific to XULTree Controls)
ExpandItem Action (TreeView Controls)

Highlight search results