SpreadsheetControl.ActiveSheetChanging Event

Occurs when an active worksheet is about to be changed via the SpreadsheetControl's UI.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v20.1.dll

Declaration

public event ActiveSheetChangingEventHandler ActiveSheetChanging
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 end-user changes an active worksheet using the control's Sheet Tab Selector. You can cancel changing an active worksheet by setting the event parameter's Cancel property to true.

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

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

NOTE

By default, the ActiveSheetChanging 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.

Implements

See Also