Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

SetCaretPosition Function

Overview

The SetCaretPosition function sets the window’s caret position.

Syntax/Parameters

Syntax

int = SetCaretPosition ( handle hObject, int x, int y );

Parameters

hObject

A handle to an Edit Object or an Edit View.

x

An int specifying the zero-based x position in native characters. The maximum adjusted value is 1,048,575.

y

An int specifying the zero-based y position. Must be less than the line count.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The position supplied must be a valid position for the specific context. Depending on the view, the caret may be moved to a valid position as required (ie., Page View moving off the internal structure of a tag to a valid edit position).

Related Functions

Platform Support

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

Legato IDE, Legato Basic