GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Six — File Functions (continued)

SetSelectArea Function

Overview

The SetSelectArea function sets the selected area for an edit object or view.

Syntax/Parameters

Syntax

int = SetSelectArea ( handle hObject );

int = SetSelectArea ( handle hObject, int s_x, int s_y, int e_x, int e_y );

int = SetSelectArea ( handle hObject, int[][] array );

Parameters

hObject

A handle to an Edit Object or an Edit View.

s_x   s_y   e_x   e_x

A series of four int values specifying the native starting and ending positions. When supplied the default select mode will be set to linear. The mode can be overridden as block mode in certain views. If omitted, the select area is reset.

array

A series of x/y x/y in table form starting and ending positions as and int array. Key name can be used as “s_x”, “s_y”, “e_x” and “e_y” or the items must be in the column order from 0 to 3.

Return Value

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

Remarks

Each accepts certain types of selections. Text based windows expect the select area to be presented as a realized position. If tabs are enabled, this will result in select issues if this is not taken into account.

The selection on the window is not updated until the Edit Object is closed or forced to update with the UpdateEditWindow function.

Related Functions

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

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.

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

 

Table of Contents	< < Previous	Next >>

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.