SelectItem Action (ListBox Controls)

Applies to TestComplete 14.72, last modified on December 24, 2020
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

Use the SelectItem action to select the specified item in the list box control.

Declaration

TestObj.SelectItem(ItemsSelOption)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Items [in]    Required    Variant    
SelOption [in]    Optional    Boolean Default value: True   
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:

Items

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.

If you enter -1, all items will be selected or deselected.

SelOption

Specifies whether the item will be selected or deselected.

Value Description
True, or 1 The Item will be selected.
False, or 0 The Item will be deselected.

Result Value

None.

Remarks

  • Unlike ClickItem or DblClickItem, SelectItem does not move the cursor. It sends selection messages to the control.

  • QtListWidget: If the tested list widget does not supports multiselection, the SelOption parameter is ignored. If SelOption is absent or ignored, SelectItem selects the specified item. It cannot unselect items. If the list widget supports multiselection, SelOption parameter specifies whether the items will be selected of deselected.

  • Chrome browser: TestComplete may fail to record the SelectItem method for web controls in Chrome. It will record ordinary coordinate clicks instead. You can replace those clicks with the SelectItem method in your tests manually.

Example

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

See Also

Selecting a Single List Box Item
ClickItem Action (ListBox Controls)
DblClickItem Action (ListBox Controls)
MultiSelect Action (ListBox Controls)

Highlight search results