ClickItemMXY Action (Ribbon Controls)

Applies to TestComplete 15.62, last modified on March 19, 2024

Description

ClickItemMXY moves the mouse pointer to the specified ribbon control’s item and then simulates a click of the middle mouse button within this item at point (X, Y). The top left coordinate of the item rectangle is (0, 0).

Declaration

TestObj.ClickItemMXY(Item, X, Y, 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    
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 path to the desired item. The path should be relative to the current item or to the tree root, respectively. To indicate that the path starts from the tree root, place the pipeline character ( | ) at the beginning of the path.

Each item in the path can be specified by its caption or index; individual captions and indexes must be separated with pipeline characters ( | ). Indexes must be enclosed in brackets - [ and ].

To indicate variable parts of the item caption, you can use the asterisk (*) and question mark (?) wildcards. The asterisk corresponds to a string of any length, the question mark corresponds to any single character. The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Note: If the item caption includes a bracket or a pipeline character, address the item by its index or with the question mark wildcard.

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 whether the CTRL, ALT or SHIFT keys will be pressed during the click. The default value is skNoShift (no shift key pressed). See TShiftKey.

Result Value

None.

Remarks

  • If the specified item is not found in the control or the specified coordinates are out of the item’s bounds, ClickItemMXY fails and posts an error message to the test log.

  • 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).

See Also

ClickItemR Action (Ribbon Controls)
ClickItemRXY Action (Ribbon Controls)
ClickItem Action (Ribbon Controls)
ClickItemM Action (Ribbon Controls)
ClickItemXY Action (Ribbon Controls)
DblClickItemMXY Action (Ribbon Controls)

Highlight search results