Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Six — File Functions (continued)

SetSelectClue Function

Overview

The SetSelectClue function sets the select clue for an existing select area.

Syntax/Parameters

Syntax

int = SetSelectClue ( handle hObject, int clue );

Parameters

hObject

A handle to an Edit Object or an Edit View.

clue

An int specifying the select clue code (EDO_SELECT_). See Remarks below.

Return Value

An int as ERROR_NONE (0) on success or a formatted error code.

Remarks

The clue aids the view and any associated editor function in processing and managing selected data. For example, whether an array of selected areas a series of rows, columns or cells.

Select clue codes can depend on the window type. The common codes are:







     
    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





 



Not all windows accept edit clues.




The clue must be set after the select area is set otherwise the clue will be wiped out by the SetSelectArea function.



Related Functions



GetSelectClue — Return the select clue.



SetSelectArea — Sets the select area as one group are or an array or groups.



SetSelectMode — Sets the select mode.



UpdateEditWindow — Updates the edit window as required.



Platform Support



Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL



Legato IDE, Legato Basic




 






    
    
    



    
    
    





GoFiler Legato Script Reference — Generated on 10/21/2024


© 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.