  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
Overview
The ListBoxSetCaret function moves the caret (focus rectangle) to a specified index position for a multiple select list box.
Syntax/Parameters
Syntax
int = ListBoxSetCaret ( int id, int index );
Parameters
id
An int containing the control ID of a list box.
index
An int specifying the zero-based index to place the caret.
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
This function sets the focus rectangle to the item at the specified index in a multiple-selection list box. If the item is not visible, it is scrolled into view.
If this function is used on a single-selection list box that does not contain a selected item, the caret index is set to the item specified by the index parameter. If the single-selection list box does contain a selected item, the function returns an error and the caret is not moved.
The control must have focus for the rectangle to be displayed.
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.