Purpose

.ColumnHeader allows you to specify the text to be displayed as the column header in a Paging Cycle.
 

Syntax

Setting:             ObjectReference.ColumnHeader = Value

Retrieving:         Variable = ObjectReference.ColumnHeader
 

Operation

ObjectReference is the Tag Name of the Paging Cycle object
Value is either an Alpha variable or a string literal
Variable is an alphanumeric variable
 

Remarks

If set, the GUI Client will automatically use the value to generate a header for the column. If one column header is specified, headers will be generated for all columns.  If nothing is set for some columns, the headings will be blank. If this feature is used, headers defined as Format objects should be removed from the Screen formats.

The property can be set as a default property in the development environment or in any logic executed prior to the first execution of the Paging Cycle.

The default value is the null string. The maximum length of the header is 250 characters.

It is important to note that the ListBox.ColumnHeader is only valid in a Paging Cycle and is invalid in a Flat Screen, resulting in the following error message:

'ColumnHeader is an invalid Method or Property for Listbox listboxname in the context of its parent object type'
 

Example

To set the column header of the field whose Tag Name is CustomerNumber to 'Cust ID':

CustomerNumber.ColumnHeader = "Cust ID"