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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

WorkbookInsertSheet Function

Overview

The WorkbookInsertSheet function inserts a data sheet into a workbook at a specified location.

Syntax/Parameters

Syntax

int = WorkbookInsertSheet ( handle hWorkbook, handle hSheet, int index );

Parameters

hWorkbook

A handle to a Workbook Object.

hSheet

A handle to a Data Sheet Object.

index

An int specifying the zero-based position to insert the sheet. If the value is -1 the sheet is appended to the workbook list of sheets.

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.

If the sheet is not named upon insert, it will be named “Sheet x” based on the index position of the insertion. This does not guarantee a unique sheet name. Use DataSheetSetSheetName to add a name to the sheet.

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

Up to 512 data sheets can be inserted.

Related Functions

DataSheetSetSheetName — Sets the name of the sheet.

WorkbookAddSheet — Adds a data sheet to a workbook.

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.

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

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.