Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

SpreadsheetControl.ActiveSheetChanged Event

Occurs after an active worksheet has been changed via the SpreadsheetControl‘s UI.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.2.dll

NuGet Package: DevExpress.Win.Spreadsheet

#Declaration

public event ActiveSheetChangedEventHandler ActiveSheetChanged

#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 end-user changes an active worksheet using the control’s Sheet Tab Selector. Before an active worksheet is changed, the SpreadsheetControl.ActiveSheetChanging event is raised.

The ActiveSheetChanged event occurs when a worksheet is removed from the workbook using the control’s UI. In this case, the ActiveSheetChanged fires first, the SpreadsheetControl.SheetRemoved event fires next, and the SpreadsheetControl.ActiveSheetChanging event does not fire.

Note

By default, the ActiveSheetChanged event does not occur when changing an active 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