Skip to main content
Row

Workbook.SheetRemoving Event

Occurs before a worksheet is removed from a workbook.

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.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

public event SheetRemovingEventHandler SheetRemoving

Event Data

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

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.

Remarks

The SheetRemoving event allows you to perform any actions before removing a worksheet from a workbook. You can cancel removing a worksheet by setting the event parameter’s Cancel property to true.

After a worksheet has been removed from a workbook, the Workbook.SheetRemoved event is raised.

Note

By default, the SheetRemoving event does not occur. To trigger it, set the WorkbookEventOptions.RaiseOnModificationsViaAPI property (accessible via the Workbook.Options.Events.RaiseOnModificationsViaAPI notation) to true.

Implements

See Also