Description
Use the CheckItem action to check or uncheck a list 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 object:
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
CheckItem has effect only in list views that display check boxes next to items (that is, whose wListViewStyleEx.CheckBoxes property is True). If Checked is True and the item is currently unchecked, it is checked, and vice versa if Checked is False. If the item is already in the specified state, no action occurs. If the specifies item is not found, CheckItem fails and posts an error message to the test log.
CheckItem is supported directly on Windows versions above NT4. On the latter system, it requires Internet Explorer 3.0 or higher to have been installed.
Example
To view an example that demonstrates how to use the CheckItem action, see Checking and Unchecking List View Items in Desktop Windows Applications.
See Also
Checking and Unchecking List View Items in Desktop Windows Applications
wChecked Property (ListView Controls)
CheckBoxes Property (ListViewStyleEx Objects)
ClickItem Action (Specific to Win32 ListView and Infragistics UltraListView Controls)
DblClickItem Action (Specific to Win32 ListView and Infragistics UltraListView Controls)
SelectItem Action (Specific to Win32ListView Controls)