Workbook.ActiveSheetChanging Event

Occurs when an active worksheet in a workbook is about to be changed.

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public event ActiveSheetChangingEventHandler ActiveSheetChanging

VB.NET

Public Event ActiveSheetChanging As ActiveSheetChangingEventHandler

Event Data

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

Property	Description
Cancel	Gets or sets whether the changing the active sheet should be canceled.
NewActiveSheetName	Gets the name of the new active worksheet. Inherited from ActiveSheetChangeEventArgsBase.
OldActiveSheetName	Gets the name of the old active worksheet. Inherited from ActiveSheetChangeEventArgsBase.

Remarks

The ActiveSheetChanging event allows you to perform any actions before an active worksheet is changed via the Spreadsheet API (by using the WorksheetCollection.ActiveWorksheet property). You can cancel changing the active worksheet by setting the event parameter’s Cancel property to true.

After an active worksheet has been changed, the Workbook.ActiveSheetChanged event is raised.

When a worksheet is removed from the workbook, the ActiveSheetChanging event does not occur, although the Workbook.ActiveSheetChanged event is fired.

Note

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

Implements

ActiveSheetChanging