CustomCellInplaceEditor Interface

Represents a custom cell in-place editor assigned to a cell or cell range in a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v22.1.Core.dll

Declaration

C#

public interface CustomCellInplaceEditor

VB.NET

Public Interface CustomCellInplaceEditor

Related API Members

The following members return CustomCellInplaceEditor objects:

• CustomCellInplaceEditorCollection.Add(CellRange, CustomCellInplaceEditorType, ValueObject, Boolean)
• CustomCellInplaceEditorCollection.Add(CellRange, CustomCellInplaceEditorType, ValueObject)
• CustomCellInplaceEditorCollection.Add(CellRange, CustomCellInplaceEditorType)
• CustomCellInplaceEditorCollection.GetCustomCellInplaceEditor(Cell)

Remarks

The CustomCellInplaceEditor object is a member of the CustomCellInplaceEditorCollection collection.

To assign a custom in-place editor of a particular type to a specific cell range in a worksheet, use the CustomCellInplaceEditorCollection.Add method.

Example

View Example

Form1.cs

// Use a date editor as the in-place editor for cells located in the "Order Date" column of the worksheet table.
CellRange dateEditRange = worksheet["Table[Order Date]"];
worksheet.CustomCellInplaceEditors.Add(dateEditRange, CustomCellInplaceEditorType.DateEdit);

// Use a combo box editor as the in-place editor for cells located in the "Category" column of the worksheet table.
// The editor's items are obtained from a cell range in the current worksheet.
CellRange comboBoxRange = worksheet["Table[Category]"];
worksheet.CustomCellInplaceEditors.Add(comboBoxRange, CustomCellInplaceEditorType.ComboBox, ValueObject.FromRange(worksheet["J3:J9"]));

// Use a check editor as the in-place editor for cells located in the "Discount" column of the worksheet table.
CellRange checkBoxRange = worksheet["Table[Discount]"];
worksheet.CustomCellInplaceEditors.Add(checkBoxRange, CustomCellInplaceEditorType.CheckBox);

// Use the custom control (SpinEdit) as the in-place editor for cells located in the "Quantity" column of the worksheet table.
// To provide the required editor, handle the CustomCellEdit event. 
CellRange customRange = worksheet["Table[Qty]"];
worksheet.CustomCellInplaceEditors.Add(customRange, CustomCellInplaceEditorType.Custom, "MySpinEdit");

Form1.vb

' Use a date editor as the in-place editor for cells located in the "Order Date" column of the worksheet table.
Dim dateEditRange As CellRange = worksheet("Table[Order Date]")
worksheet.CustomCellInplaceEditors.Add(dateEditRange, CustomCellInplaceEditorType.DateEdit)

' Use a combo box editor as the in-place editor for cells located in the "Category" column of the worksheet table.
' The editor's items are obtained from a cell range in the current worksheet.
Dim comboBoxRange As CellRange = worksheet("Table[Category]")
worksheet.CustomCellInplaceEditors.Add(comboBoxRange, CustomCellInplaceEditorType.ComboBox, ValueObject.FromRange(worksheet("J3:J9")))

' Use a check editor as the in-place editor for cells located in the "Discount" column of the worksheet table.
Dim checkBoxRange As CellRange = worksheet("Table[Discount]")
worksheet.CustomCellInplaceEditors.Add(checkBoxRange, CustomCellInplaceEditorType.CheckBox)

' Use the custom control (SpinEdit) as the in-place editor for cells located in the "Quantity" column of the worksheet table.
' To provide the required editor, handle the CustomCellEdit event. 
Dim customRange As CellRange = worksheet("Table[Qty]")
worksheet.CustomCellInplaceEditors.Add(customRange, CustomCellInplaceEditorType.Custom, "MySpinEdit")

Related GitHub Examples

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

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-use-custom-cell-editors-to-create-a-data-entry-form-t419595/CS/DevAVInvoicing/Form1.cs#L127

if (sheet.Name == "Invoice") {
    IList<CustomCellInplaceEditor> editors = sheet.CustomCellInplaceEditors.GetCustomCellInplaceEditors(sheet.Selection);
    if (editors.Count == 1)

VB.NET

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

If sheet.Name = "Invoice" Then
    Dim editors As IList(Of CustomCellInplaceEditor) = sheet.CustomCellInplaceEditors.GetCustomCellInplaceEditors(sheet.Selection)
    If editors.Count = 1 Then