SpreadsheetControlOptions.RaiseEventsOnModificationsViaAPI Property

Gets or sets whether to raise certain events when changes are made in code. These events usually fire only when the document is modified via the control’s UI. This is a dependency property.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v24.2.dll

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public bool RaiseEventsOnModificationsViaAPI { get; set; }

VB.NET

Public Property RaiseEventsOnModificationsViaAPI As Boolean

Property Value

Type	Description
Boolean	true, to raise events for changes made in code; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to RaiseEventsOnModificationsViaAPI
SpreadsheetControl	.Options .RaiseEventsOnModificationsViaAPI

Remarks

The following events usually fire only for changes performed via the control’s UI. If the RaiseEventsOnModificationsViaAPI property is true, these events are raised by changes performed via the API and control’s UI.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RaiseEventsOnModificationsViaAPI property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml#L1602

<dxsps:SpreadsheetControl.Options>
    <dxsps:SpreadsheetControlOptions RaiseEventsOnModificationsViaAPI="True"/>
</dxsps:SpreadsheetControl.Options>