ClickItemXY Action (ListBox Controls)

Applies to TestComplete 14.80, last modified on April 15, 2021
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 ClickItemXY action simulates a single click at the specified point within a list box item.

Declaration

TestObj.ClickItemXY(ItemXYShift)

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    
X [in]    Required    Integer    
Y [in]    Required    Integer    
Shift [in]    Optional    TShiftKey Default value: skNoShift   
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 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.

X

Specifies the horizontal coordinate of the point at which a click will be simulated. The coordinate is relative to the top left corner of the item.

Y

Specifies the vertical coordinate of the point at which a click will be simulated. The coordinate is relative to the top left corner of the item.

Shift

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

Result Value

None.

Remarks

  • If the specified item is not found, ClickItemXY fails and posts an error message to the test log.

  • Desktop testing: If TestObj refers to an object of a non-DPI-aware application running with a DPI setting other than 100%, set the X and Y parameter values relative to the application (as if the application is running with the 100% DPI setting).

  • Web testing: If the Use CSS pixels for scaled pages option is enabled (by default), set the X and Y parameter values relative to the web page, regardless of the browser zoom and the system's DPI setting.

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

Example

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

See Also

ClickItem Action (ListBox Controls)
DblClickItem Action (ListBox Controls)
DblClickItemR Action (ListBox Controls)
ClickItemRXY Action (ListBox Controls)
DblClickItemXY Action (ListBox Controls)

Highlight search results