Description

Use the ClickColumnHeader action to simulate a click of the left mouse button over a column header.

Declaration

TestObj.ClickColumnHeader(Column, View, 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
View	[in]	Optional	Variant	Default value: 0
Shift	[in]	Optional	TShiftKey	Default value: skNoShift
Result	None

Applies To

The method is applied to the following objects:

Developer Express QuantumGrid, DevExpressQuantumGridLevel

View Mode

This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.

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 that contains the column. You can enter the view’s zero-based index or its caption. The default value is 0 and corresponds to the leftmost view in the current grid level.

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

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 column is not found, or if it is not displayed in the grid, ClickColumnHeader fails and posts an error message to the test log.

Example

To view an example that demonstrates how to use the ClickColumnHeader action, see Sorting Data in Developer Express QuantumGrid.

ClickColumnHeader Action (Specific to DevExpressQuantumGrid Controls)