  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The SetSelectMode function sets the select mode for an existing select area. When adding a selected area, the mode will automatically be set to linear or array depending on the type of selection made by SetSelectArea.
Syntax/Parameters
Syntax
int = SetSelectMode ( handle hObject, int mode );
Parameters
hObject
A handle to an Edit Object or an Edit View.
mode
An int specifying the select mode code (EDO_). See Remarks below.
Return Value
An int as ERROR_NONE (0) on success or a formatted error code.
Remarks
The mode determines what is actually selected.
The selection mode codes are as follows:
| Code | Value | Comment | |||
| EDO_NOT_SELECTED | 0 | Nothing Selected — Simple caret. Any existing selection is reset. | |||
| EDO_LINEAR_SELECT | 1 | Linear Select — Text is selected from a start x/y to an end x/y. | |||
| EDO_BLOCK_SELECT | 2 | Block Select — Text is selected from a start x/y to an end x/y but only within a box area. | |||
| EDO_ARRAY_SELECT | 3 | Array Select — Multiple items have been selected. This is normally used for tables. | |||
| EDO_OBJECT_SELECT | 4 | Object Select — An object, such as an image, is selected. Note that the selected area is the point position immediately after the start of the object’s tag. |
Note that not all modes are supported in all window types.
The mode must be set after the select area is set otherwise the mode will be wiped out by the SetSelectArea function.
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.