SpreadsheetControl.CustomCellEdit Event

Allows you to assign a custom in-place editor to a cell.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v18.1.dll

Declaration

C#

public event SpreadsheetCustomCellEditEventHandler CustomCellEdit

VB.NET

Public Event CustomCellEdit As SpreadsheetCustomCellEditEventHandler

Event Data

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

Property	Description
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.
RepositoryItem	Gets or sets the in-place editor for the current cell.
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.
ValueObject	Gets a value associated with the CustomCellInplaceEditor object assigned to the cell.
Worksheet	Gets the worksheet that contains the cell. Inherited from SpreadsheetCellEventArgsBase.

Remarks

The CustomCellEdit event fires when an end-user is about to start editing a cell and allows you to supply a custom in-place editor to the edited cell. Use the event’s Cell, ColumnIndex and RowIndex parameters to identify the currently edited cell. To provide an editor for editing a cell value, set the event’s RepositoryItem parameter to the repository item representing the required in-place editor. You can select one of the standard editors shipped with the XtraEditors Library or create your own editor by deriving it from an existing one if none of the standard editors meet your requirements. Refer to the Repositories and Repository Items topic for more information on the repository technology.

For details on how to embed custom in-place editors within worksheet cells, see the How to: Assign Custom In-place Editors to Worksheet Cells example.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomCellEdit 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-assign-custom-in-place-editors-to-worksheet-cells-t385401/CS/Spreadsheet_CustomCellEditors/Form1.cs#L17

#region #CustomCellEdit
spreadsheetControl.CustomCellEdit += spreadsheetControl1_CustomCellEdit;
// ...

VB.NET

how-to-assign-custom-in-place-editors-to-worksheet-cells-t385401/VB/Spreadsheet_CustomCellEditors/Form1.vb#L16

'            #Region "#CustomCellEdit"
            AddHandler spreadsheetControl.CustomCellEdit, AddressOf spreadsheetControl1_CustomCellEdit
            ' ...

how-to-use-custom-cell-editors-to-create-a-data-entry-form-t419595/VB/DevAVInvoicing/Form1.vb#L84

Private Sub spreadsheetControl1_CustomCellEdit(ByVal sender As Object, ByVal e As SpreadsheetCustomCellEditEventArgs) Handles spreadsheetControl1.CustomCellEdit
    If Not e.ValueObject.IsText Then