Rename a specified worksheet in the workbook.
Note: Changing the worksheet name in an event that fires after the BeforeCommentsSetup event may break comment functionality in the view instance.
| Overload Name | Description |
|---|---|
| General | Rename one or all worksheets. |
Rename one or all worksheets.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SpecifySheetToRenameBy |
Select how to specify which worksheet to rename.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumber
|
| SheetToRename | Specify the sheet-name or sheet-number of the sheet to rename, depending on SpecifySheetToRenameBy. |
| NewSheetName | The new name of the sheet. |