Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter EighteenDataView Integration (continued)

DataViewFindCell Function

Overview

The DataViewFindCell function locates a cell by its display content.

Syntax/Parameters

Syntax

string = DataViewFindCell ( handle object, string match,
                       [int row, int column] | [string address],
                       [boolean case], [boolean partial] );

Parameters

object

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

match

A string containing the text to match against cells. It can be complete or partial depending on the partial parameter.

row and column

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

address

An optional string that can be used as a cell address as an alternative to specifying the row and column parameters. If the case parameter is to be supplied, a cell address or row and column must be provided. The default is 0,0 (A1).

case

An optional boolean value when TRUE forces a match of each string by case. When FALSE, the string case is not checked. The default value is TRUE.

partial

An optional boolean value when TRUE allows for a partial match of the cell string. When FALSE, the string must match character for character (except for case depending on the case parameter. The default value isFALSE.

Return Value

Returns a string containing the cell address of the first matching cell or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

Note this function matches the working/display text of each cell. To scan an entire sheet, specify the cell position and on each match iteration, advance the cell position and supply the new position to the function.

Related Functions

Platform Support

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