Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetSelectEndXPosition Function

Overview

The GetSelectEndXPosition returns the native X position in characters for the end of a selection within an edit window.

Syntax/Parameters

Syntax

int = GetSelectEndXPosition ( 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 X position or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The returned value is a native position which means it does not necessarily represent the position on the screen if tabs are enabled and the line contains tabs. The end position is not inclusive. In other words, the returned position is the start of the next non-selected region.

Related Functions

Platform Support

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

Legato IDE, Legato Basic