  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The ComboBoxSelectItem function selects an item within the list box portion of the combo box and loads the text into the edit control or select area.
Syntax/Parameters
Syntax
int = ComboBoxSelectItem ( int id, [int index | string data] );
Parameters
id
An int containing the control ID of a combo box.
index
An optional 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. Or,
data
An optional string containing a string to match. If this parameter is empty, the select state is reset and nothing is highlighted. If neither the index or data are provided, the select position is reset.
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 ComboBoxSelectItem function selects a string and scrolls it into view, if necessary. When the new string is selected, the combo box removes the highlight from the previously selected string. Resetting the selected item with a -1 or "" value for the index or data parameter will clear the select area (edit area) on combo boxes with the CBS_DROPDOWNLIST style set.
When the data parameter is used, the string match is exact including text case.
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.