Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EighteenDataView Integration (continued)

DataViewCellGetByName Function

Overview

The DataViewCellGetByName function searches for a cell by its name and returns the working/display text for a cell.

Syntax/Parameters

Syntax

string = DataViewCellGetByName ( handle object, string name );

Parameters

object

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

name

A string specifying an existing cell name.

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 DataViewCellGetByName function returns the current text contained in a cell after locating the cell by its name. 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.

Note that uniqueness of the name is not tested. The first match cell is returned.

Related Functions

Platform Support

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