SpreadsheetControl.SheetRenamed Event

Occurs after a worksheet has been renamed via the SpreadsheetControl‘s UI.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

C#
VB.NET

csharp

public event SheetRenamedEventHandler SheetRenamed

Public Event SheetRenamed As SheetRenamedEventHandler

Event Data

The SheetRenamed event's data class is SheetRenamedEventArgs. The following properties provide information specific to this event:

Property	Description
NewName	Gets the new name of the renamed worksheet.
OldName	Gets the former name of the renamed worksheet.

Remarks

Handle the SheetRenamed event to perform specific actions each time an end-user renames a worksheet using the control’s UI.

To cancel renaming a worksheet, handle the SpreadsheetControl.SheetRenaming event that is raised before a worksheet is renamed.

Note

By default, the SheetRenamed event does not occur when renaming a worksheet in code. However, this event will also be triggered by changes made via an API if you set the WorkbookEventOptions.RaiseOnModificationsViaAPI property (accessible via the SpreadsheetControl.Options.Events.RaiseOnModificationsViaAPI notation) to true.