CustomCellInplaceEditorCollection Interface

Represents a collection of the custom cell in-place editors assigned to worksheet cells.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public interface CustomCellInplaceEditorCollection :
    ISimpleCollection<CustomCellInplaceEditor>,
    IEnumerable<CustomCellInplaceEditor>,
    IEnumerable,
    ICollection

VB.NET

Public Interface CustomCellInplaceEditorCollection
    Inherits ISimpleCollection(Of CustomCellInplaceEditor),
             IEnumerable(Of CustomCellInplaceEditor),
             IEnumerable,
             ICollection

Related API Members

The following members return CustomCellInplaceEditorCollection objects:

• Worksheet.CustomCellInplaceEditors

Remarks

To assign a custom in-place editor of a particular type to a specific cell range in a worksheet, use the Add method. To remove the specified custom cell in-place editor(s) from the collection, use the Remove or RemoveAt method.

For details on how to use custom editors for in-place editing of cell content, refer to the How to: Assign Custom In-place Editors to Worksheet Cells example.

Copy and Paste In-Place Editors in the User Interface

A custom in-place editor is not copied in any clipboard operations, and when a user drags-and-drops the cell with an editor.

In tables, when the new row is added above or below a row with in-place editors, this new row contains in-place editors.

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")