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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

WorkbookAddSheet Function

Overview

The WorkbookAddSheet function adds a data sheet to a workbook.

Syntax/Parameters

Syntax

int = WorkbookAddSheet ( handle hWorkbook, handle hSheet, string name );

Parameters

hWorkbook

A handle to a Workbook Object.

hSheet

A handle to a Data Sheet Object.

name

An optional string specifying the name of the data sheet. If the data sheet does not have a name and one is not provided, a default name will be added to the Data Sheet Object based on the relative position in the workbook.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError and GetLastErrorMessage to retrieve additional information.

Remarks

Each handle is added to an internal array for later use on export. The object handles added must remain intact until the workbook is written.

The sheet can also be named using the DataSheetSetSheetName function.

This function does not update the internal information table. It is updated when the workbook is exported.

Up to 512 data sheets can be added.

Related Functions

DataSheetSetSheetName — Sets the name of the sheet.

WorkbookCreate — Creates a Workbook Object for XDS export.

WorkbookDeleteSheet — Deletes a sheet from a specified position.

WorkbookExport — Exports a workbook as an XDS file.

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

WorkbookInsertSheet — Inserts a data sheet at a specified position.

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.

Platform Support

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

Legato IDE, Legato Basic

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.