Back to Devexpress

Workbook.SheetRenamed Event

officefileapi-devexpress-dot-spreadsheet-dot-workbook-1c22b2fc.md

latest2.4 KB
Original Source

Workbook.SheetRenamed Event

Occurs after a worksheet has been renamed.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public event SheetRenamedEventHandler SheetRenamed
vb
Public Event SheetRenamed As SheetRenamedEventHandler

Event Data

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

PropertyDescription
NewNameGets the new name of the renamed worksheet.
OldNameGets the former name of the renamed worksheet.

Remarks

The SheetRenamed event fires after the Worksheet.Name property value has been changed by using the Worksheet.Name property. Handle this event to perform actions every time a worksheet is renamed.

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

Note

This event does not occur by default. The event fires only if the WorkbookEventOptions.RaiseOnModificationsViaAPI property is true.

Implements

SheetRenamed

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace