Back to Devexpress

SpreadsheetCellEditorBehaviorOptions.CommitMode Property

officefileapi-devexpress-dot-xtraspreadsheet-dot-spreadsheetcelleditorbehavioroptions.md

latest3.5 KB
Original Source

SpreadsheetCellEditorBehaviorOptions.CommitMode Property

Gets or sets a mode that specifies when the SpreadsheetControl.CellValueChanged event should be raised after a cell value has been edited via the cell editor and committed.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
[DefaultValue(CellEditorCommitMode.Auto)]
public CellEditorCommitMode CommitMode { get; set; }
vb
<DefaultValue(CellEditorCommitMode.Auto)>
Public Property CommitMode As CellEditorCommitMode

Property Value

TypeDefaultDescription
CellEditorCommitModeAuto

A CellEditorCommitMode enumeration value.

|

Available values:

NameDescription
Auto

Defined automatically when the SpreadsheetControl.CellValueChanged event should be raised for cells whose values have been edited via the cell editor and committed.

| | Always |

The SpreadsheetControl.CellValueChanged event is raised for each cell whose value has been edited via the cell editor and committed (even if a new cell value is the same as the value before editing).

| | ChangedOnly |

The SpreadsheetControl.CellValueChanged event is raised for each cell whose value has been changed via the cell editor and committed. If a new cell value is the same as the value before editing, the event does not occur.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to CommitMode
SpreadsheetBehaviorOptions

.CellEditor .CommitMode

|

Remarks

To access the CommitMode property, use the SpreadsheetControl.Options.Behavior.CellEditor.CommitMode notation. This property allows you to specify when the SpreadsheetControl.CellValueChanged event should be raised after a cell value has been edited via the cell editor and committed: each time (CellEditorCommitMode.Always) or only if a cell value has been changed (CellEditorCommitMode.ChangedOnly).

See Also

SpreadsheetCellEditorBehaviorOptions Class

SpreadsheetCellEditorBehaviorOptions Members

DevExpress.XtraSpreadsheet Namespace