ui.Dialog.getSortKey

Returns the name of the sort field selected by the user.

Syntax

getSortKey(
   name STRING )
  RETURNS STRING
  1. name is the name of the screen record, see Identifying screen-arrays in ui.Dialog methods.

Usage

The getSortKey() method returns the form field name (table column) selected by the user to sort rows.

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 getSortKey() method returns NULL.