.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

Workbook.ActiveSheetChanged Event

Occurs after an active worksheet in a workbook has been changed.

You need an active 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.v20.2.dll

Declaration

public event ActiveSheetChangedEventHandler ActiveSheetChanged
Public Event ActiveSheetChanged As ActiveSheetChangedEventHandler

Event Data

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

Property Description
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

Handle the ActiveSheetChanged event to perform specific actions each time an active worksheet is changed via the Spreadsheet API (by using the WorksheetCollection.ActiveWorksheet property). Before an active worksheet is changed, the Workbook.ActiveSheetChanging event is raised.

The ActiveSheetChanged event occurs when a worksheet is removed from the workbook using the Spreadsheet API. In this case, the ActiveSheetChanged fires first, the Workbook.SheetRemoved event fires next, and the Workbook.ActiveSheetChanging event does not fire.

NOTE

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

Implements

See Also