Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlSetSortColumn Function

Overview

The DataControlSetSortColumn function set a sort on column and sort mode.

Syntax/Parameters

Syntax

int = DataControlSetSortColumn ( int id, int column, [int mode] );

Parameters

id

An int containing the control ID of the data control.

column

An optional int specifying a zero-based column index or -1 to reset the sort markers on the column heading. The default is -1.

mode

An optional int as zero to order as ascending or non-zero for descend order. The default is zero.

Return Value

An int as ERROR_NONE or a formatted error code on failure.

Remarks

The mode of the sort is set by the column flags using the DataControlSetColumnFlags function.

Resetting the sort does not restore the order to the original order.

When data is subsequently added to a sorted control, it must be manually resorted. Resetting the content does not reset the sort state.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic