Description
Sets the state of the specified item in a ribbon control.
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:
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 the state of the item. There are three possible states for checkable items in a ribbon control. To set the state of the specified item, the following constants can be used in the State parameter:
| Value | Description |
|---|---|
cbUnchecked, False or 0 |
The item is unchecked. |
cbChecked, True or 1 |
The item is checked. |
cbGrayed or 2 |
The item is switched to grayed (indeterminate state). |
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 (Ribbon Controls)
DblClickItem Action (Ribbon Controls)