CheckItem Action (TreeView Controls)

Applies to TestComplete 15.0, last modified on November 17, 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

Use the CheckItem action to check or uncheck a tree view item specified by index or by caption.

Declaration

TestObj.CheckItem(Item, Checked)

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    
Checked [in]    Required    Boolean    
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:

Item

Specifies the desired item. You can enter the item’s index (from 0) or its 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.

Checked

Specifies whether the specified item should be checked (True) or unchecked (False).

Result Value

None.

Remarks

If Checked is True and the item is unchecked, it is checked; if Checked is False and the item is checked, it is unchecked. If the item is already in the specified state, no action is made. If the specifies item is not found, CheckItem fails and posts an error message to the test log.

See Also

ClickItem Action (TreeView Controls)
DblClickItem Action (TreeView Controls)

Highlight search results