Description
Use the ClickColumnHeader action to simulate a click of the left mouse button over a column header.
Declaration
TestObj.ClickColumnHeader(Column, 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 | |
| Shift | [in] | Optional | TShiftKey | Default value: skNoShift |
| Result | None | |||
Applies To
The method is applied to the following objects:
Developer Express ExpressQuantumTreeList, Developer Express XtraTreeList, DevExpressQuantumTreeListView and 2 more objects, DevExpressXtraTreeListView, Ext JS Tree Panel « Collapse the list
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.
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, ClickColumnHeader fails and posts an error message to the log.