GoFiler Legato Script Reference   Legato v 1.6d Application v 6.1b

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

8.6.8 Workbooks

Programmers can group sheets together into a workbook and save the workbook in XDS format or alternatively open an XDS as a workbook and extract specific sheets or information table data. XDS workbook is also the format used by the Data View window, if the application has that feature enabled.

For reading, a workbook is opened and mapped. The actual data sheets are not loaded until a sheet handle is requested.

Once workbook has been opened or created, API functions can be used to add, insert and delete sheets for subsequent export.

For writing, the object allows data sheets to be added and then written to a file. Generally, it is a good idea to name each sheet. Sheet names should be unique.

Excel workbook export is also supported depending on the implementation platform.

See Appendix B — XML Data Sheet Format Specification for information on the XML format of data sheets and workbooks.

8.6.9 Workbooks Functions

Reading Workbooks

WorkbookGetSheet — Returns a data sheet object handle for a workbook sheet.

WorkbookOpen — Opens a workbook from a specified file or URL.

WorkbookGetInfoTable — Returns any globally named data (info table) from workbook.

WorkbookGetSheetCount — Returns the number of sheets within the workbook.

Managing Workbooks

WorkbookAddSheet — Adds a data sheet to a workbook.

WorkbookCreate — Creates a Workbook Object for XDS export.

WorkbookExport — Exports a workbook as an XDS file.

WorkbookDeleteSheet — Deletes a sheet from a specified position.

WorkbookInsertSheet — Inserts a data sheet at a specified position.

See also:

DataSheetEnumerateSheets — Returns an index to the named sheets and properties in a workbook.

DataSheetSetSheetName — Sets the name of the sheet.

Page revised 2025-08-15

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 08/18/2025

© 2012-2025 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.