Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

PageControlGetCaretX Function

Overview

The PageControlGetCaretX function returns the current caret X position.

Syntax/Parameters

Syntax

int = PageControlGetCaretX ( int id );

Parameters

id

An int containing the control ID of the page control.

Return Value

An int as a zero-based file X position or -1 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 position.

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