CustomCellInplaceEditorCollection.GetCustomCellInplaceEditors(CellRange) Method

Returns a collection of the custom cell in-place editors assigned to cells of the specified range.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

IList<CustomCellInplaceEditor> GetCustomCellInplaceEditors(
    CellRange range
)

VB.NET

Function GetCustomCellInplaceEditors(
    range As CellRange
) As IList(Of CustomCellInplaceEditor)

Parameters

Name	Type	Description
range	CellRange	A CellRange object containing the custom cell in-place editors to be returned.

Returns

Type	Description
IList<CustomCellInplaceEditor>	A IList<T><CustomCellInplaceEditor,> collection of the custom cell in-place editors residing in the specified cell range.

Remarks

Use the GetCustomCellInplaceEditors method to obtain a collection of custom cell in-place editors residing within a specific cell range. The GetCustomCellInplaceEditors method returns an empty list in the following cases:

• If the range parameter of the method is null.
• If the CellRange object specified by the range parameter doesn’t belong to the worksheet owning the current CustomCellInplaceEditorCollection collection that calls this method.
• If the specified range doesn’t contain any custom editors assigned to its cells.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetCustomCellInplaceEditors(CellRange) method.

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#

winforms-spreadsheet-use-custom-cell-editors/CS/DevAVInvoicing/Form1.cs#L127

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

wpf-spreadsheet-control-create-a-data-entry-form/CS/WpfDataEntryFormSample/SpreadsheetBindingManager.cs#L251

{
    var editors = sheet.CustomCellInplaceEditors.GetCustomCellInplaceEditors(sheet.Selection);
    if (editors.Count == 1)

VB.NET

winforms-spreadsheet-use-custom-cell-editors/VB/DevAVInvoicing/Form1.vb#L118

If Equals(sheet.Name, "Invoice") Then
    Dim editors As IList(Of CustomCellInplaceEditor) = sheet.CustomCellInplaceEditors.GetCustomCellInplaceEditors(sheet.Selection)
    If editors.Count = 1 Then spreadsheetControl1.OpenCellEditor(CellEditorMode.Edit)

wpf-spreadsheet-control-create-a-data-entry-form/VB/WpfDataEntryFormSample/SpreadsheetBindingManager.vb#L234

If _sheet IsNot Nothing Then
    Dim editors = _sheet.CustomCellInplaceEditors.GetCustomCellInplaceEditors(_sheet.Selection)
    If editors.Count = 1 Then