SpreadsheetControl.CellBeginEdit Event

Occurs before the cell editor is opened.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v18.2.dll

Declaration

C#

public event CellBeginEditEventHandler CellBeginEdit

VB.NET

Public Event CellBeginEdit As CellBeginEditEventHandler

Event Data

The CellBeginEdit event's data class is SpreadsheetCellCancelEventArgs. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets whether the operation performed on the processed event should be canceled.
Cell	Gets the cell for which the event is fired. Inherited from SpreadsheetCellEventArgsBase.
ColumnIndex	Gets the index of the column that contains the cell. Inherited from SpreadsheetCellEventArgsBase.
Formula	Gets the formula that is currently contained in the cell. Inherited from SpreadsheetCellEventArgsBase.
FormulaInvariant	Gets the formula in the invariant culture that is currently contained in the cell. Inherited from SpreadsheetCellEventArgsBase.
RowIndex	Gets the index of the row that contains the cell. Inherited from SpreadsheetCellEventArgsBase.
SheetName	Gets the name of the worksheet that contains the cell. Inherited from SpreadsheetCellEventArgsBase.
Value	Gets the value currently contained in the cell. Inherited from SpreadsheetCellEventArgsBase.
Worksheet	Gets the worksheet that contains the cell. Inherited from SpreadsheetCellEventArgsBase.

Remarks

Handle the CellBeginEdit event to perform any actions before the cell editor (the cell in-place editor or formula bar) is activated by an end-user. To access the cell for which the cell editor is about to be invoked, use the Cell parameter. A value and formula currently contained in this cell are returned by the Value and Formula parameters, respectively.

To prevent cell content from being modified via the cell in-place editor or formula bar, handle the event and set the Cancel parameter to true.

The SpreadsheetControl.CellEndEdit or SpreadsheetControl.CellCancelEdit event occurs before the cell editor is closed, depending on whether the entered cell value should be committed or rolled back.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CellBeginEdit event.

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.

C#

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/CS/SpreadsheetCustomization/Form1.cs#L35

spreadsheetControl1.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheetControl1.CellBeginEdit +=spreadsheetControl1_CellBeginEdit;
spreadsheetControl1.MouseWheel += spreadsheetControl1_MouseWheel;

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/CS/SpreadsheetCustomization/Form1.cs#L43

spreadsheetControl1.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheetControl1.CellBeginEdit += spreadsheetControl1_CellBeginEdit;
spreadsheetControl1.MouseWheel += spreadsheetControl1_MouseWheel;

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/CS/WindowsFormsApplication1/FormatPainterProvider.cs#L26

spreadsheet.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheet.CellBeginEdit += spreadsheetControl1_CellBeginEdit;
spreadsheet.SheetRemoving += Spreadsheet_SheetRemoving;

VB.NET

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/VB/SpreadsheetCustomization/Form1.vb#L34

AddHandler spreadsheetControl1.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheetControl1.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit
AddHandler spreadsheetControl1.MouseWheel, AddressOf spreadsheetControl1_MouseWheel

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/VB/SpreadsheetCustomization/Form1.vb#L45

AddHandler spreadsheetControl1.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheetControl1.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit
AddHandler spreadsheetControl1.MouseWheel, AddressOf spreadsheetControl1_MouseWheel

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/VB/WindowsFormsApplication1/FormatPainterProvider.vb#L28

AddHandler spreadsheet.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheet.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit
AddHandler spreadsheet.SheetRemoving, AddressOf Spreadsheet_SheetRemoving