Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EighteenDataView Integration (continued)

DataViewGetCellRect Function

Overview

The DataViewGetCellRect function returns the display position of a cell in client or screen coordinates (rectangle).

Syntax/Parameters

Syntax

int[] = DataViewGetCellRect ( handle object,
                          [int row, int column] | [string address],
                          [boolean screen] );

Parameters

object

A handle either to a Data View Object or to a window that employs Data View.

row and column

An optional pair of int values specifying the row and column of the cell. Or,

address

An optional string that can be used as a cell address as an alternative to specifying the row and column parameters.

screen

An optional boolean value specifying whether to return the position in screen coordinates.

Return Value

An array of four int values as the position and size of the cell’s display area or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

The array is in the order and key named from 0 to 3 as “x”, “y”, “w” and “h”. Return values are in pixels.

Remarks

The cell must be at least in partial view to retrieve its position. If the cell is not in view, an error will be returned.

If the window is not active or visible, the cell position may be erroneous.

Platform Support

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