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.v24.2.dll

NuGet Package: DevExpress.ExpressApp.TreeListEditors.Win

Declaration

C#
VB.NET

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

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:

TreeListEditor2

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