getColumnObject( )

Topic group Related topics

Returns a reference to the GridColumn object for a designated column

Syntax

<oRef>.getColumnObject(<exp N> )

<oRef>

The name of the Grid object

<exp N>

An integer representing the column position. For the leftmost column in a grid, n=1.

Property of

Grid

Description

Each column in a grid is represented by a GridColumn object. For a grid that has custom columns defined, the getColumnObject( ) method will return a reference to the GridColumn object for column position <n>.

<exp n> is an integer from 1 up to the number of columns in the grid where;

n=1 indicates the current leftmost column

n=2 indicates the current second column from the left

and so on.

The getColumnObject( ) method provides a means to determine the current column order, save the column order to disk and restore it later on.

If a grid does NOT have custom columns defined, the getColumnObject( ) method returns a null value.