Purpose

.HeadingSortOnColumnClick enables you to turn on sorting for a particular column in a Paging Area. This property can be applied to the column headers used in certain objects used in Paging Areas, and can be specified on a per column basis.

(Open Client only)

Syntax

Setting:          ObjectReference.HeadingSortOnColumnClick = Value

Retrieving:     Variable = ObjectReference.HeadingSortOnColumnClick
 

Operation

ObjectReference is the Tag Name of the cycle or Paging Cycle object
Value is the setting for the property (TRUE or 1 = sort, FALSE or 0 = no sort)
Variable is an alphanumeric variable 
 

Remarks

Enabling the property turns on sorting for a particular column with the HeadingSortOnColumnClick property, this means that when you click on the column in the Paging Cycle, the paging data is sorted based on that column. Columns with the capability of being sorted (HeadingSortOnColumnClick property enabled) are denoted by greyed out downward pointing icon, sorted columns are denoted with a non-greyed out pointing icon which points up or down depending on the current sort order.

This property interacts with the Open Client and MFC SortOnColumnClick property in the following ways:

• When neither the HeadingSortOnColumnClick property or the SortOnColumnClick property for the Paging Cycle is enabled, sorting on columns is not possible.

• When the SortOnColumnClick property is disabled and the HeadingSortOnColumnClick property is enabled, sorting on that column and any other columns with the HeadingSortOnColumnClick property enabled is available.

This provides fine control over which columns can be sorted. Setting sorting at the Paging Cycle level means that any column can be sorted, setting sorting at column level means you can configure sorting on a per column basis.

Examples

To set the .HeadingSortOnColumnClick property of an edit box whose Tag Name is OrderDisplay:

OrderDisplay.HeadingSortOnColumnClick = TRUE