Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Six — File Functions (continued)

GetSelectClue Function

Overview

The GetSelectClue function retrieves a clue code as to what HTML item is currently selected in an edit window.

Syntax/Parameters

Syntax

int = GetSelectClue ( handle hObject );

Parameters

hObject

A handle to an Edit Object or an Edit View.

Return Value

Returns an int indicating what type of selection has been made or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

An edit clue is useful in determining what type of HTML item is currently selected. For example, within a table, the GetSelectClue function could indicate whether the selected item is a cell, a column, a row, or the entire table itself.

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 set edit clues.

Related Functions

GetEditObject — Get the Edit Object for a window.

GetSelectCount — Return the number of selected items (if the mode is array).

GetSelectMode — Return the current select mode.

GetSelectEndXPosition — Return the select end X position.

GetSelectEndYPosition — Return the select end Y position.

GetSelectStartXPosition — Return the select start X position.

GetSelectStartYPosition — Return the select start X position.

SetSelectClue — Sets the select clue.

Platform Support

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

Legato IDE, Legato Basic

 

GoFiler Legato Script Reference — Generated on 12/16/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.