spreadsheetRenameSheet

Renames a sheet in a workbook.

spreadsheetRenameSheet(spreadsheet, oldName, newName) → returns void

Argument Reference

spreadsheet any
Required

The spreadsheet object.

oldName string
Required

Current name of the sheet.

newName string
Required

New name for the sheet.

Compatibility

RustCFML:

Not supported on wasm32. Uses a different signature: spreadsheetRenameSheet(spreadsheetObj, sheetName [, sheetNumber]), where sheetName is the new name and sheetNumber is the 1-based sheet to rename (default 1). Member form: renameSheet(sheetName, sheetNumber).

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