CheckItem Action (Specific to Mycrosoft, Infragistics, Syncfusion, and Telerik ToolBar Controls)

Applies to TestComplete 14.91, last modified on July 20, 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

CheckItem moves the mouse to the toolbar Item and then checks or unchecks this item.

Declaration

TestObj.CheckItem(ItemChecked)

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 item should be checked (True) or unchecked (False).

Result Value

None.

Remarks

If the specified item does not exist or cannot be checked, CheckItem fails and posts an error message to the test log. To determine whether a toolbar item can be checked, use the wIsCheckButton property.

If the item is already checked, CheckItem posts a message to the test log. To determine whether the item is already in the checked or unchecked state, use the wChecked property.

See Also

Selecting Toolbar Buttons
CheckItem Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
CheckItem Action (Toolbar Controls)
wChecked Property (ToolBar Controls)
wIsCheckButton Property (ToolBar Controls)
ClickItem Action (ToolBar Controls)
DblClickItem Action (ToolBar Controls)
wButtonPos Property (ToolBar and MenuBar Controls)
wButtonID Property (ToolBar and MenuBar Controls)
wButtonText Property (ToolBar Controls)

Highlight search results