SpreadsheetControl.CustomCellEdit Event
Allows you to assign a custom in-place editor to a cell.
Namespace: DevExpress.Xpf.Spreadsheet
Assembly: DevExpress.Xpf.Spreadsheet.v18.2.dll
Declaration
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. |
| EditSettings | Gets or sets an object that contains the custom cell editor’s settings. |
| 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. |
| 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 user starts to edit a cell and allows you to supply a custom editor from the DXEditors Library to the cell. Use the event’s Cell, ColumnIndex and RowIndex parameters to identify the currently edited cell. To specify the in-place editor, set the event’s EditSettings parameter to the BaseEditSettings descendant corresponding to the editor you want to use. The *EditSettings class provides all the information needed to create a fully-functional editor. The actual editor is created when a user starts to edit a cell, and is automatically destroyed when editing is completed.
Refer to the Custom Cell In-place Editors topic for more information on how to embed custom in-place editors in worksheet cells.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.