Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

PageControlGetCaret Function

Overview

The PageControlGetCaretX function returns the current caret X/Y code position in the form of an array.

Syntax/Parameters

Syntax

int[] = PageControlGetCaret ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int array as two 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 “X” and “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