ui.Dialog.getSortKeyAt

Returns the name of field used as grouping or sorting column, for a given sort column position.

Syntax

getSortKeyAt(
   name STRING,
   index INTEGER
)
  RETURNS STRING
  1. name is the name of the screen record, see Identifying screen-arrays in ui.Dialog methods.
  2. index is the sort column position (1 = first sort column)

Usage

The getSortKeyAt() method returns the form field name (table column) used as sorting column, for the record list identified by the screen record name, and the sort column position specified by index parameter.

This method is used in the context of the ON SORT trigger.

When the ON SORT trigger is fired because the sort order was reset, the getSortKeyAt() method returns NULL.