Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

ControlGetPosition Function

Overview

The ControlGetPosition function returns the position of the control on the desktop in either screen or page coordinates.

Syntax/Parameters

Syntax

int [] = ControlGetPosition ( int id, [boolean client] );

Parameters

id

An int that identifies the dialog control.

client

An optional boolean specifying the type of coordinates to retrieve. If TRUE, the returned values are relative to the containing dialog page. The default is FALSE.

Return Value

Returns an int array containing coordinates or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The array contains the key name positions: “left”, “top”, “right”, “bottom”, “width” and “height” in order, containing the position of top left and bottom right points of the control. The position takes into account the non-client area and the bottom-right coordinates of the rectangle are exclusive. In other words, the pixel at (right, bottom) lies immediately outside the rectangle bounding the window.

The positions returned specify the complete window area including containing borders, frames and other non-client items.

When the client flag is set, the positions returned are relative to the dialog page client area.

Related Functions

Platform Support

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

Legato IDE, Legato Basic