  |
GoFiler Legato Script Reference
Legato v 1.6e Application v 6.3a
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
TextControlGetSelectClue Function†
Overview
The TextControlGetSelectClue function returns the select clue for the current state of the control.
Syntax/Parameters
Syntax
int = TextControlGetSelectClue ( int id );
Parameters
id
An int containing the control ID of the Text Control.
Return Value
An int as a select clue for the selected item or a formatted error code on failure. Common errors include: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open.
Remarks
The select clue expands on the select mode. For example, selected cells can make up a column or a region. The values are as follows:
| Code | Value | Comment | ||||
| EDO_SELECT_NO_CLUE | 0 | Undetermined | ||||
| EDO_SELECT_ALL | 1 | Entire document | ||||
| EDO_SELECT_BLOCK | 2 | Block (whole boundaries) | ||||
| EDO_SELECT_CELL | 3 | Table cell | ||||
| EDO_SELECT_COLUMN | 4 | Table column | ||||
| EDO_SELECT_ROW | 5 | Table row | ||||
| EDO_SELECT_REGION | 6 | Table square region of cells | ||||
| EDO_SELECT_TABLE | 7 | Table | ||||
| EDO_SELECT_IMAGE | 8 | Image/picture object | ||||
| EDO_SELECT_PAGE | 9 | Page | ||||
| EDO_SELECT_PAGE_FIELD | 10 | Page field | ||||
| EDO_SELECT_CONTROL | 11 | Format control object | ||||
| EDO_SELECT_FRAME | 12 | Frame object | ||||
| EDO_SELECT_OBJECT | 13 | General object |
Use the TextControlGetSelectMode function to determine the mode of the selection.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
Page revised 2025-10-20
| Table of Contents | < < Previous | Next >> |
© 2012-2025 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.