SpreadsheetControl.SheetRemoving Event

Occurs when a worksheet is about to be removed from a workbook.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v21.2.dll

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 an end-user removes a worksheet from a workbook using the control’s UI. 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 SpreadsheetControl.SheetRemoved event is raised.

Note

By default, the SheetRemoving event does not occur when removing 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.

See Also