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 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:

AngularUI Grid, Borland String Grid, Borland TDBGrid and 36 more objects, Developer Express ExpressVerticalGrid, Developer Express WPF Grid, Developer Express XtraGrid, Developer Express XtraVerticalGrid, DevExpressXtraGridView, DevExpressXtraVerticalGridColumn, Ext JS Grid Panel, Flex DataGrid, Infragistics UltraGrid, Infragistics WebDataGrid, Infragistics XamDataGrid, InfragisticsUltraGridView, InfragisticsWebDataGridView, Java Swing Table, JavaFX TableView, MFC Grid, Microsoft DataGrid, Microsoft DataGridView, Qt TableWidget, Rogue Wave Stingray Objective Grid, Rogue Wave Stingray Objective GridEx, SAP GUI ShellGridView, Silverlight Grid, Spark DataGrid, Syncfusion Essential Grid (GridGroupingControl), Syncfusion Grid Controls, SyncfusionEssGridView, Telerik RadGridView for Silverlight, Telerik RadGridView for WinForms, Telerik RadGridView for WPF, TMS TAdvStringGrid, WPFToolkitDataGrid, XamDataGridView, Xceed Grid, YUI 2 DataTable, YUI 3 DataTable « Collapse the list

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 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:

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.

Example

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

ClickColumnHeader Action (Grid Controls)