Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

GetSelectEndYPosition Function

Overview

The GetSelectEnYXPosition returns the Y position in number of lines for the end of a selection within an edit window.

Syntax/Parameters

Syntax

int = GetSelectEndYPosition ( handle hObject, [int index] );

Parameters

hObject

A handle to an Edit Object or an Edit View.

index

An optional int containing an array index for the selection. This value is useful for array selections to determine the end position for an item within the array.

Return Value

Returns an int presenting the ending Y position or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The Y position can be thought of as a number of lines within the selection, with the count beginning at zero (first line). The end position is inclusive. In other words, the returned position is the actual end of the selected region.

Related Functions

Platform Support

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

Legato IDE, Legato Basic