TreeListEditor Class

Represents a Windows Forms List Editor that displays data in the form of a tree-like structure.

Namespace: DevExpress.ExpressApp.TreeListEditors.Win

Assembly: DevExpress.ExpressApp.TreeListEditors.Win.v22.1.dll

Declaration

C#

public class TreeListEditor :
    ColumnsListEditor,
    IDXPopupMenuHolder,
    IComplexListEditor,
    IControlOrderProvider,
    IOrderProvider,
    ILookupListEditor,
    IFocusedElementCaptionProvider,
    INodeObjectAdapterProvider,
    ISupportFooter,
    IExportable,
    ISupportUpdate,
    IRequireContextMenu,
    IRequireDXMenuManager,
    ISupportBorderStyle,
    ISupportScriptRecorder,
    ISupportFilterEditor

VB.NET

Public Class TreeListEditor
    Inherits ColumnsListEditor
    Implements IDXPopupMenuHolder,
               IComplexListEditor,
               IControlOrderProvider,
               IOrderProvider,
               ILookupListEditor,
               IFocusedElementCaptionProvider,
               INodeObjectAdapterProvider,
               ISupportFooter,
               IExportable,
               ISupportUpdate,
               IRequireContextMenu,
               IRequireDXMenuManager,
               ISupportBorderStyle,
               ISupportScriptRecorder,
               ISupportFilterEditor

Remarks

List Editors are used by List Views to display object collections in a UI. The TreeListEditor is implemented in the TreeList Editors module, and displays data in the form of a tree:

To display object collections, the TreeListEditor uses an instance of the ObjectTreeList as the underlying control. The ObjectTreeList is a descendant of the TreeList class.

The TreeListEditor supports a range of features out of the box:

• Implements the ISupportAppearanceCustomization interface - supports conditional appearance:

  

• Implements the IExportable interface - can be exported via the ExportController and printed via the PrintingController:

  

  

• Implements the IDXPopupMenuHolder interface, and provides an ActionDX pop-up menu:

  

• Implements the IControlOrderProvider interface - supports the RecordsNavigationController‘s PreviousObject and NextObject Actions:

  

Since it is not possible to represent an arbitrary object collection in the form of a tree, the objects that will be displayed via the TreeListEditor must implement the ITreeNode interface. To learn how to implement this interface, refer to the Display a Tree List using the ITreeNode Interface topic.

For additional information on the TreeListEditor and an overview of the TreeListEditors module, refer to the TreeList Editors Module Overview topic.

Note

TreeListEditor supports only Client mode (CollectionSourceBase.DataAccessMode).

Related GitHub Examples

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

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/TreeListAppearanceControllerEx.cs#L11

base.OnTreeListChanged();
if (base.Active.ResultValue && base.View != null && base.View.Editor != null && base.View.Editor is TreeListEditor && ((TreeListEditor)base.View.Editor).TreeList != null) {
    ((TreeListEditor)base.View.Editor).TreeList.ShowingEditor += new System.ComponentModel.CancelEventHandler(control_ShowingEditor);

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/CS/E520.Module.Win/Controllers/WinFilterTreeListViewController.cs#L24

base.OnViewControlsCreated();
TreeListEditor treeListEditor = View.Editor as TreeListEditor;
if (treeListEditor != null) {

VB.NET

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

MyBase.OnTreeListChanged()
If MyBase.Active.ResultValue AndAlso MyBase.View IsNot Nothing AndAlso MyBase.View.Editor IsNot Nothing AndAlso TypeOf MyBase.View.Editor Is TreeListEditor AndAlso CType(MyBase.View.Editor, TreeListEditor).TreeList IsNot Nothing Then
    AddHandler CType(View.Editor, TreeListEditor).TreeList.ShowingEditor, AddressOf control_ShowingEditor

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/VB/E520.Module.Win/Controllers/WinFilterTreeListViewController.vb#L26

MyBase.OnViewControlsCreated()
Dim treeListEditor As TreeListEditor = TryCast(View.Editor, TreeListEditor)
If treeListEditor IsNot Nothing Then

Implements

IComplexListEditor

IFocusedElementCaptionProvider

IExportable

ISupportUpdate

Inheritance

Object

ListEditor

ColumnsListEditor

TreeListEditor