Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

PageControlGetSelectArea Function

Overview

The PageControlGetSelectArea function returns an array of points for a linearly selected area.

Syntax/Parameters

Syntax

int[] = PageControlGetSelectArea ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int array as four zero-based file positions or empty on failure. Use the GetLastError function to retrieve a formatted error code. 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 position within the control is always based on an X/Y file code position. Key names are “s_x”, “s_y”, “e_x” and “e_y” for the zeroeth and first positions respectively.

The X position is always a native position, i.e., tabs are not expanded and treated as a single character position.

Related Functions

Platform Support

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

Legato IDE, Legato Basic