Description
The CheckItem action moves the mouse pointer to a certain bar control item and then checks or unchecks it.
Declaration
TestObj.CheckItem(Item, State)
| 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 | |
| State | [in] | Required | Variant | |
| Result | None | |||
Applies To
The method is applied to the following objects:
Developer Express BarControl, Developer Express BarDockControl, Developer Express BarManager, Developer Express Ribbon
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.
State
Specifies whether an item should be checked or unchecked.
Possible values:
| Value | Description |
|---|---|
cbChecked, True or 1 |
The control item will be checked. |
cbUnchecked, False or 0 |
The control item will be unchecked. |
Result Value
None.
Remarks
If the specified item does not exist, or does not allow checking, CheckItem fails and posts an error message to the test log. If the specified item was clicked, but its state did not changed, CheckItem posts a warning message to the test log.
See Also
ClickItem Action (Bar Controls)
DblClickItem Action (Bar Controls)