IndexOrder - cWebList

Returns the database index number currently used to sort the rows of a data-aware grid or list

Type: Function

Return Data Type: Integer

Parameters: None

Return Value


Syntax
Function IndexOrder Returns Integer

Call: Get IndexOrder to IntegerVariable


Description

Returns the database index number currently used to sort the rows of a data-aware grid or list.

The IndexOrder function is called every time a data-aware list needs to know what index to use to find records. It returns the index to be used for finding.

Therefore, this function controls index ordering. This makes it an ideal candidate for debugging and for augmentation.

Controlling Index Order


When working with data-aware lists, follow these guidelines for controlling index order:

1. Use piSortColumn to control index order

2. Always set an initial piSortColumn value

3. If you need to further control index order, augment the IndexOrder function

4. Do not set these properties:



See Indexes and Ordering with Data Aware cWebLists for a more complete description of this process.