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

The ClickItem action moves the mouse pointer to the list box item specified by its index or name, and then simulates a single click over it.

Declaration

TestObj.ClickItem(Item, Shift)

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
Shift	[in]	Optional	TShiftKey	Default value: skNoShift
Result	None

Applies To

The method is applied to the following objects:

View Mode

This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.

Parameters

The method has the following parameters:

Item

Specifies the caption or zero-based index of the desired item. The caption could contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to the string of any length, the question mark - to any single character. 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.

Note for Win32ListBox controls: If the Win32ListBox object has the LBS_OWNERDRAWFIXED or LBS_OWNERDRAWVARIABLE style and does not have the LBS_HASSTRINGS style, the Item parameter should specify the item’s index, not a caption. See also OWNERDRAW Controls Support.

Note for JList controls: TestComplete recognizes the captions properly only if the items were inherited from the JLabel or AbstractButton classes (in most cases they are). Otherwise the captions may be interpreted as empty strings.

Shift

Specifies a key which will be pressed during the click. See TShiftKey.

Result Value

None.

Remarks

If the item is not found, ClickItem fails and posts an error message to the test log.
Chrome browser: TestComplete may fail to record the ClickItem method for web controls in Chrome. It will record ordinary coordinate clicks instead. You can replace those clicks with the ClickItem method in your tests manually.

Example

To view an example that demonstrates how to use the ClickItem action, see Selecting a Single List Box Item.

ClickItem Action (ListBox Controls)