ColumnOrdering - cDbCJGridColumn

Returns the best index for ordering this column

Type: Function
Return Data Type: Integer

Syntax

Function ColumnOrdering Returns Integer

Call Example

Get ColumnOrdering to IntegerVariable

Description

ColumnOrdering can be used to determine what the best index for a column is. This function uses the column's binding information (piBindingTable and piBindingColumn) and the grid's request find mode (peRequestFindMode) to find a suitable index . This index returned is the index for the Grid's server table. The server table may not be the same as the column's piBindingTable (e.g. parent tables). This function takes care of this.

If there is no good index, -1 is returned.

You can augment this function to return a special index order for any column. You can also call this function to determine if a column has an index.

Return Value

Best index for this column, -1 if there is no good index.