GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

DataControlGetSortMode Function

Overview

The DataControlGetSortMode function returns the current sort mode, ascending or descending.

Syntax/Parameters

Syntax

int = DataControlGetSortMode ( int id );

Parameters

id

An int containing the control ID of the data control.

Return Value

An int containing the flag as 0 for ascending and 1 as descending. On failure, the return value is 0. Use the GetLastError function to retrieve error information.

Remarks

If a column is not sorted, the return value will be 0. To sort a column, either use the DataControlSetSortColumn or enable sorting on a specific column using the DataControlSetColumnFlags function with one of the sort modes.

Related Functions

DataControlGetSortColumn — Returns the column index being used to sort the control's data.

DataControlSetColumnFlags — Sets the display and behavior flags for a specific column

DataControlSetSortColumn — Sets the sort to a specific column and more. Optionally resets sort.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.