HoverMouseColumnHeader Action (Specific to DevExpressQuantumGrid Controls)

Applies to TestComplete 14.74, last modified on March 31, 2021

Description

The HoverMouseColumnHeader action moves the mouse pointer to point (X, Y) within the header of the specified column. If the coordinates of the mouse pointer, that is X and Y, are not specified, HoverMouseColumnHeader moves the pointer to the center of the header.

Declaration

TestObj.HoverMouseColumnHeader(ColumnViewXY)

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    
View [in]    Optional    Variant Default value: 0   
X [in]    Optional    Integer Default value: -1   
Y [in]    Optional    Integer Default value: -1   
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 grid column whose header will be clicked. You can specify the column using its caption or zero-based index. For more information, see the Remarks section.

View

Specifies the grid view in which the column resides. You can enter the view’s zero-based index or its caption. For more information, see the Remarks section.

The default value of the View parameter is 0.

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.

Result Value

None.

Remarks

  • You can specify the grid view by assigning its index or caption in the View parameter. Similarly, the Column parameter that specifies a grid column can take the column’s index or its caption. When specifying the column by the index, remember that the indexes correspond to the columns’ position in the grid’s internal columns collection rather than their visible position in the grid.

    You can use wildcards (* and ?) or regular expressions to mark variable parts of the caption when specifying the value for the Column or View parameter. 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.

  • If the specified coordinates are out of the header cell's bounds or if the specified column is not found, HoverMouseColumnHeader 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

HoverMouseCell Action (Specific to DevExpressQuantumGrid Controls)
HoverMouseRowIndicator Action (Specific to DevExpressQuantumGrid Controls)

Highlight search results