Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlGetTable Function

Overview

The DataControlGetTable function retrieves the entire contents of the data control and returns it as a string table.

Syntax/Parameters

Syntax

string [][] = DataControlGetTable ( int id, [boolean null] );

Parameters

id

An int containing the control ID of the data control.

null

An optional boolean value as TRUE or FALSE. When set to TRUE, cells that are spanned over (merged) will be loaded with the text “}null{” otherwise those cells are returned as an empty string. The default is FALSE.

Return Value

A UTF encoded string table containing the entire contents of the control as each cell’s display text. The array will be empty on error. Since empty strings are invalid data, the GetLastError, IsError or IsNotError function must be used to determine if an error occurred.

Remarks

Spanned cells are returned as empty string entries unless the null parameter is set to TRUE or non-zero. Using the null cell option allows readers of the table to determine if a cell was spanned over.

Related Functions

Platform Support

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

Legato IDE, Legato Basic