Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EighteenDataView Integration (continued)

DataViewCellGetText Function

Overview

The DataViewCellGetText function returns the working/display text for a cell.

Syntax/Parameters

Syntax

string = DataViewCellGetText ( handle object, [int row, int column] | [string address] );

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.

Return Value

Returns a string containing the cell’s text or an empty string if the cell does not contain text or on failure. Use the GetLastError function to retrieve error information.

Remarks

The DataViewCellGetText function returns the current text contained in a cell. In most cases, this is the same as the cell display text but for certain types it may return the data that supports the cell. For example, if the cell type is checkbox, the return value will be blank, 0 or 1. The maximum size of the text of a cell is 2MB.

Related Functions

Platform Support

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