  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
Overview
The DataSheetToTable function takes the entire contents of the data sheet and returns it as a string table. The sheet may be specified by handle or opened directly from a compatible file.
Syntax/Parameters
Syntax
string [][] = DataSheetToTable ( handle hSheet, [boolean null] );
string [][] = DataSheetToTable ( string name, [int sheet], [boolean null] );
Parameters
hSheet
A handle to a Data Sheet object. Or,
name
A string specifying a compatible file (XDS) to load the sheet data from.
sheet
An optional int as zero-based sheet number. This parameter can only be used if the name parameter is supplied. If omitted, the first sheet is loaded.
null
An optional boolean as TRUE or FALSE. When set to TRUE, cells that are spanned over (merged) will be loaded with the text “}null{” otherwise, if FALSE, those cells are returned as an empty string. The default is FALSE.
Return Value
A 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.
Additional textual information is available by using the GetLastErrorMessage function when a syntax error is returned with respect to the content of source file.
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.