  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
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
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.