ClickColumnHeaderRXY Action (Grid Controls)

Applies to TestComplete 15.0, last modified on October 19, 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

Use the ClickColumnHeaderRXY action moves the mouse pointer to (X, Y) relative to the top left corner of the specified column header cell, and then simulates a single click of the right mouse button.

Declaration

TestObj.ClickColumnHeaderRXY(Column, X, Y, Shift)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Column [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:

Column

Specifies the column whose header needs to be clicked. This parameter takes the column’s index or its caption.

The index is zero-based and corresponds to the column’s position within the object's internal columns collection rather than the column’s visible position in the object.

The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to a string of any length, the question mark corresponds 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.

XtraVerticalGrid: The XtraVerticalGrid control may contain multi-editor columns. These columns contain several headers (or nested columns) within each column. TestComplete considers these nested columns as ordinary columns, and both types of columns share the same index space.

The following image illustrates a typical structure of the XtraVerticalGrid control:

X

Specifies the horizontal coordinate of the mouse pointer where the click will be simulated. The coordinate is relative to the top left corner of the cell.

Y

Specifies the vertical coordinate of the mouse pointer where the click will be simulated. The coordinate is relative to the top left corner of the cell.

Shift

Sets whether the Shift, Alt or Ctrl keys are pressed during the click event (see TShiftKey). By default, this parameter is skNoShift (the shift keys are not pressed).

Result Value

None.

Remarks

  • If the specified column is not found, or is not displayed in the grid, ClickColumnHeaderRXY fails and posts an error message to the 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.

Example

To view an example that demonstrates how to use the ClickColumnHeaderRXY action, see Working With Grids - Basic Concepts.

See Also

ClickColumnHeaderRXY Action (Specific to DevExpressQuantumGrid Controls)
DblClickColumnHeaderRXY Action (Grid Controls)

Highlight search results