| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.SetName
Sets the name of the sheet.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.SetName"; bookRef; sheetIndex; Name ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref |
| sheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 |
| Name | The new name for the sheet. | "First Sheet" |
Result
Returns OK or error message.
Description
Sets the name of the sheet.Examples
Set sheet name:
MBS( "XL.Sheet.SetName"; $book; 0; "MyReport" )
See also
- XL.CopySheet
- XL.Sheet.GetName
- XL.Sheet.GetPaper
- XL.Sheet.SetCol
- XL.Sheet.SetHeader
- XL.Sheet.SetMerge
- XL.Sheet.SetPaper
- XL.Sheet.SetRow
- XL.Sheet.SetRows
- XL.Sheet.SetZoom
Release notes
- Version 8.2
- Fixed parameter handling for XL.Sheet.SetNamedRange function.
This function checks for a license.
Created 18th August 2014, last changed 16th May 2019
