WorkbookEventOptions.RaiseOnModificationsViaAPI Property

Gets or sets whether to raise certain events when changes are made via an API. Normally, these events are fired only when the document is modified by using the control UI.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

public bool RaiseOnModificationsViaAPI { get; set; }

VB.NET

Public Property RaiseOnModificationsViaAPI As Boolean

Property Value

Type	Description
Boolean	true, to raise events for changes made via API; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to RaiseOnModificationsViaAPI
WinForms Controls	SpreadsheetControlOptions	.Events.RaiseOnModificationsViaAPI
Office File API	DocumentOptions	.Events.RaiseOnModificationsViaAPI

Remarks

The following events are normally raised only for changes performed via the control’s UI. If the RaiseOnModificationsViaAPI is set to true, these events are triggered by changes performed via an API and the control’s UI.

• SpreadsheetControl.CellValueChanged
• SpreadsheetControl.ActiveSheetChanging
• SpreadsheetControl.ActiveSheetChanged
• SpreadsheetControl.ColumnsInserting
• SpreadsheetControl.ColumnsInserted
• SpreadsheetControl.ColumnsRemoving
• SpreadsheetControl.ColumnsRemoved
• SpreadsheetControl.RowsInserting
• SpreadsheetControl.RowsInserted
• SpreadsheetControl.RowsRemoving
• SpreadsheetControl.RowsRemoved
• SpreadsheetControl.ScrollPositionChanged
• SpreadsheetControl.SelectionChanged
• SpreadsheetControl.SheetInserted
• SpreadsheetControl.SheetRemoving
• SpreadsheetControl.SheetRemoved
• SpreadsheetControl.SheetRenaming
• SpreadsheetControl.SheetRenamed
• SpreadsheetControl.ShapeInserted
• SpreadsheetControl.ShapeRemoving
• SpreadsheetControl.ShapeRemoved
• SpreadsheetControl.PanesFrozen
• SpreadsheetControl.PanesUnfrozen