TreeList.ActiveEditor Property

Gets the currently active cell editor.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

[Browsable(false)]
public BaseEdit ActiveEditor { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property ActiveEditor As BaseEdit

Property Value

Type	Description
BaseEdit	A BaseEdit descendant representing the currently active editor. null (Nothing in Visual Basic) if no cell is being edited at the moment.

Remarks

Cell values are edited by means of editors inherited from the BaseEdit class. Editors available for editing cell values are stored within the repository, which can be accessed via the Tree List’s EditorContainer.RepositoryItems property. The repository allows you to add, delete and customize individual editors within it.

You can assign editors to columns via the TreeListColumn.ColumnEdit property. In such a case, each cell in the column will use the specified editor. On the other hand, you can specify an editor for each individual cell by handling the TreeList.CustomNodeCellEdit event.

The editor is automatically created when a cell it is assigned to is being edited. This prevents the creation of multiple instances of the editor. As the result, the ActiveEditor property returns null (Nothing in Visual Basic) if no cell is being edited at the moment. Otherwise it returns the editor assigned to the cell whose value is being edited.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveEditor property.

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#

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/CS/WinSolution.Module.Win/TreeListInplaceEditViewController.cs#L69

ObjectTreeList treeList = (ObjectTreeList)sender;
IGridInplaceEdit activeEditor = treeList.ActiveEditor as IGridInplaceEdit;
if (activeEditor != null && treeList.FocusedObject is IXPSimpleObject) {

how-to-implement-hot-tracking-in-the-xtratreelist-e766/CS/XtraTreeListHotTrack/Form1.cs#L32

hotTrackNode = value;
if (treeList1.ActiveEditor != null)
    treeList1.PostEditor();

VB.NET

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/VB/WinSolution.Module.Win/TreeListInplaceEditViewController.vb#L72

Dim treeList As ObjectTreeList = DirectCast(sender, ObjectTreeList)
Dim activeEditor As IGridInplaceEdit = TryCast(treeList.ActiveEditor, IGridInplaceEdit)
If activeEditor IsNot Nothing AndAlso TypeOf treeList.FocusedObject Is IXPSimpleObject Then

how-to-implement-hot-tracking-in-the-xtratreelist-e766/VB/XtraTreeListHotTrack/Form1.vb#L30

hotTrackNode_Renamed = value
If treeList1.ActiveEditor IsNot Nothing Then
    treeList1.PostEditor()

how-to-implement-the-cells-multi-selection-feature-in-treelist-e2795/VB/WindowsApplication1/Helper/BlockSelector.vb#L42

If e.Modifiers = Keys.Control AndAlso e.KeyCode = Keys.C Then
    Dim editor As TextEdit = TryCast(fList.ActiveEditor, TextEdit)
    If editor Is Nothing Then