SORT-ITEMS Action

This document covers the following topics:

Description

Sorts the specified list view control or column, or the child items of the specified tree view control or item. For list views in either of the icon modes, the items are re-arranged.

Note that after this action has been called, new items will no longer be automatically inserted in sorted sequence, even if the appropriate SORTED attribute value is set to TRUE.

Parameters

Name/Data Type Explanation
Object

(HANDLE OF LISTVIEW,

HANDLE OF LISTVIEWCOLUMN,

HANDLE OF TREEVIEW or

HANDLE OF TREEVIEWITEM)

 Input

Handle of list view control or item, or tree view control or item, that is to be sorted.

Note:
If a list view control handle is specified, and one or more list view columns have been defined, the sort is performed as if the handle of the primary column had been specified.

Descending (L) Input (optional parameter)

Sort direction.

FALSE=ascending sequence (default);

TRUE=descending sequence.
Recurse (L) Input (optional parameter)

Only applicable in case of tree view control or item.

FALSE=only direct child items are to be sorted (default);

TRUE=sort extended to also cover indirect child items.
Flags (I4) Input (optional parameter)

Sort flags. May be any combination of the following values (as specified by passing the sum of the individual flag values):

1=Case-insensitive sort

2=Use word sort instead of string sort (e.g., "co-ordinate" = "coordinate").

For list view controls with columns, the default value (if this parameter is omitted)

is based on the corresponding STYLE attribute flags of the column being sorted.

Otherwise the default is 0 (case-sensitive string sort).

Response (I4) Output

Natural error (if applicable).

Example: 

PROCESS GUI ACTION SORT-ITEMS WITH #LV-1 GIVING *ERROR