spreadsheetRenameSheet

Renames a sheet in a spreadsheet workbook. The sheet is identified by its 1-based sheet number (the first sheet is 1). The fluent member form is renameSheet(sheetName, sheetNumber).

spreadsheetRenameSheet(spreadsheetObj, sheetName, sheetNumber) → returns any

This function requires RustCFML.  Not supported on Lucee, Adobe ColdFusion, etc.
  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. spreadsheetRenameSheet
  5. RustCFML
  6. 0 Issue
  7. Edit
See Also:   spreadsheetCreateSheet   spreadsheetSetActiveSheet   spreadsheetNew

Argument Reference

spreadsheetObj any
Required

The spreadsheet workbook object.

sheetName string
Required

The new name for the sheet.

sheetNumber numeric
Default: 1

1-based index of the sheet to rename (default 1).

Compatibility

RustCFML:

Not supported on wasm32.

Examples
Sample code invoking the spreadsheetRenameSheet function

Rename the default Sheet1 to People.

wb = Spreadsheet("xlsx");
spreadsheetRenameSheet(wb, "People", 1);
writeDump(wb.info().sheetnames);

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub