Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.Book.InsertSheet

Inserts a new sheet to this book at position index, returns the new sheet index.

Component Version macOS Windows Linux Server iOS SDK
XL 3.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.Book.InsertSheet"; bookRef; Index; Name { ; InitSheet } )   More

Parameters

Parameter Description Example Flags
bookRef The reference to the workbook. Please use XL.LoadBook to load a file. $ref
Index The index where to insert the sheet. 0
Name The name for the new sheet. "Taxsheet"
InitSheet The index of an existing sheet to use as template.
Must be from the same book to copy sheet.
0 Optional

Result

Returns new sheet index or error message.

Description

Inserts a new sheet to this book at position index, returns the new sheet index.
Use initSheet parameter if you wish to copy an existing sheet.
Note initSheet must be only from this book.

See also

This function checks for a license.

Created 18th August 2014, last changed 18th May 2023


XL.Book.GetText - XL.Book.IsDate1904

💬 Ask a question or report a problem