Description
The SwitchItem action sets the specified state of the item.
Declaration
TestObj.SwitchItem(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 | 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.
Checked
Specifies the item’s state:
| Value | Description |
|---|---|
"Off", False or 0
|
The item is unchecked. |
"On", True or 1
|
The item is checked. |
Result Value
None.
Remarks
If the specified item is not found, SwitchItem fails and posts an error message to the test log.
To determine whether the specified item is already in the on or off state, use the wSwitchState property.
If the underlying item does not support the specified state, the method fails and posts an error message to the test log.
See Also
Selecting Toolbar and Navigation Bar Items
wIsItemSwitchable Property (Specific to iOS Toolbar and NavigationBar Controls)
wSwitchState Property (Specific to iOS Toolbar and NavigationBar Controls)