  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The ListBoxAddItem function adds an item to a list box.
Syntax/Parameters
Syntax
int = ListBoxAddItem ( int id, mixed value );
Parameters
id
An int containing the control ID of a list box.
value
A string or
an int value to add to the list box. If the list box has the tab option set, the string can contain tab characters to mark the columns.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure, 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
If the list box is created with the LBS_SORT style, the ListBoxAddItem function inserts the item into the appropriate spot alphabetically. If the sort option is not enabled, the item is added to the end of the list box.
Note that adding an integer value to the list box converts the integer to a string so that when the selection in the box is retrieved with the ListBoxGetItemText function, it is returned as a string.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.