Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

ListBoxSelectItem Function

Overview

The ListBoxSelectItem function selects (or deselects) an item in a multiple select style list box.

Syntax/Parameters

Syntax

int = ListBoxSelectItem ( int id, int index, [boolean state] );

Parameters

id

An int containing the control ID of a list box.

index

An int containing the zero-based index of the position to select. If this parameter is -1, the select state is reset and nothing is highlighted.

state

An optional boolean value to set the state as selected or not selected, and TRUE (1) or FALSE (0) respectively. The default is TRUE.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Commons errors include: 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. If index is -1, the return value is -1 even though no error occurred.

Remarks

The ListBoxSelectItem function selects a string and scrolls it into view, if necessary. This function selects or deselects a specified item. This function requires the list box to be multi-select enabled (with LBS_MULTIPLESEL style specified).

Related Functions

Platform Support

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

Legato IDE, Legato Basic