Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

ListBoxSetTabPositions Function

Overview

The ListBoxSetTabPositions function allows tab positions to be set for a list box control. The list box must have the LBS_USETABSTOPS style set.

Syntax/Parameters

Syntax

int = ListBoxSetTabPositions ( int id, [int p1, int p2, ...] | [int list[] ] );

Parameters

id

An int containing the control ID of a list box.

p1, p2, p3, ...

A list of one or more int parameters specifying the tab position; or,

list[]

An int array of tab positions.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

Tab positions of the list box are part of a dialog box, the integers are in dialog template units. The tab stops must be sorted in ascending order; backward tabs are not allowed. The LBS_USETABSTOPS style must be set in the source declaration to use this option.

When items are displayed, the tab character (0x09) forces the text position of that portion of the entry being displayed to be left aligned at the tab position. If there are more tabs in the item than specified, a default position will be used.

Note, that like text tab stops, if there is not sufficient space in an area for the text, the next tab will skip to the next position.

A maximum of 63 tabs may be added.

Related Functions

Platform Support

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

Legato IDE, Legato Basic