Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EighteenDataView Integration (continued)

DataViewCellGetData Function

Overview

The DataViewCellGetData function returns all the data fields associated with a cell.

Syntax/Parameters

Syntax

string [] = DataViewCellGetData ( 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 array containing various data fields related to the cell or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The DataViewCellGetData function does not return the display text associated with the cell. The returned array will have the following fields present even if the fields do not contain data or if the cell does not physically exist:

  Element Key Name   Description  
  FieldTypeData   Extended field data for non-text style cells.  
  NativeData   Native data for non-text style cells. For example, the text of a radio style button.  
  Name   The name of the cell.  
  Description   The description of the cell.  
  Tip   An optional popup tip. Tips are only displayed if the host view supports tooltip popups.  
  Comment   A general comment.  
  Review   A review note.  
  PrivateA   General caller private data.  
  PrivateB   General caller private data.  

 

Related Functions

Platform Support

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