TreeListControl Class

The TreeList control.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.dll

Declaration

C#

public class TreeListControl :
    TreeListControlBase

VB.NET

Public Class TreeListControl
    Inherits TreeListControlBase

Related API Members

The following members return TreeListControl objects:

• ResourceTreeControl.TreeList

Remarks

The WPF DXTreeList is a TreeView-Grid multi-purpose data-aware control that can display information as a TREE, a GRID, or a combination of both - in either data bound or unbound mode.

The TreeListControl inherits the majority of market-leading features exposed by the WPF DXGrid. This includes: data editing, automatic and custom sorting and filtering, full end-user customization options, editable unbound columns and DevExpress Expression editor, built-in validation, automatic and manual summary calculation, UI virtualization and per-pixel scrolling, template and style support, UI localization, extendable context menus, design-time support and much more…

The WPF TreeList control uses the same View-based data presentation approach introduced by the DXGrid for WPF. It presents the most widely used method of presenting data - TreeListView. This view supports multi-column display of hierarchical data, data shaping and layout customization features such as Sorting and Filtering, Data Editing via Embedded Cell Editors, Column Auto Width, Column Reordering and Resizing, Fixed Columns, Field Chooser Window and Extendable Context Menus.

To bind the TreeList control to a data source, use the DataControlBase.ItemsSource property.

Concepts

• Hierarchical Data Presentation

  The information is displayed in a TREE from hierarchical data structures.

• On-Demand Data Loading

  A tree can be created on demand. Child nodes are dynamically created and initialized when their parent node is expanded.

• Unbound Data Binding Mode

  You can manually create a TREE in XAML or code. Nodes can be represented by objects of different types. The only requirement is that these data objects should have common fields (columns).

• Tree-Traversal API

  To simplify managing hierarchical data (without writing additional recursive code), the WPF DXTreeList ships with an easy to use API, so you can sequentially visit nodes starting from a specified node down to the last node.

Example

This example shows how to create a self referencing data structure and display it within the TreeListControl.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/connecting-to-hierarchical-data-e3244.

Application.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Data
Imports System.Linq
Imports System.Windows

Namespace TreeList_DataBinding
    ''' <summary>
    ''' Interaction logic for App.xaml
    ''' </summary>
    Partial Public Class App
        Inherits Application

    End Class
End Namespace

Application.xaml

<Application x:Class="TreeList_DataBinding.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             StartupUri="MainWindow.xaml">
    <Application.Resources>

    </Application.Resources>
</Application>

MainWindow.xaml

<Window 

    xmlns:dxt="http://schemas.devexpress.com/winfx/2008/xaml/grid"    
        x:Class="TreeList_DataBinding.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <dxt:TreeListControl Name="treeList">
            <dxt:TreeListControl.Columns>
                <dxt:TreeListColumn FieldName="Name" Header="Employee Name" />
                <dxt:TreeListColumn FieldName="Position" />
                <dxt:TreeListColumn FieldName="Department" />
            </dxt:TreeListControl.Columns>
            <dxt:TreeListControl.View>
                <dxt:TreeListView Name="treeListView1" AutoWidth="True"
                                  KeyFieldName="ID" ParentFieldName="ParentID" />
            </dxt:TreeListControl.View>
        </dxt:TreeListControl>
    </Grid>
</Window>

MainWindow.xaml.vb

Imports System.Windows

Namespace TreeList_DataBinding
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()
            treeList.ItemsSource = Stuff.GetStuff()
            treeListView1.ExpandAllNodes()
        End Sub
    End Class
End Namespace

Employees.vb

Imports System
Imports System.Collections.Generic

Namespace TreeList_DataBinding

    Public Class Employee
        Public Property ID() As Integer
        Public Property ParentID() As Integer
        Public Property Name() As String
        Public Property Position() As String
        Public Property Department() As String
    End Class

    Public NotInheritable Class Stuff

        Private Sub New()
        End Sub

        Public Shared Function GetStuff() As List(Of Employee)

            Dim stuff_Renamed As New List(Of Employee)()
            stuff_Renamed.Add(New Employee() With {.ID = 1, .ParentID = 0, .Name = "Gregory S. Price", .Department = "", .Position = "President"})
            stuff_Renamed.Add(New Employee() With {.ID = 2, .ParentID = 1, .Name = "Irma R. Marshall", .Department = "Marketing", .Position = "Vice President"})
            stuff_Renamed.Add(New Employee() With {.ID = 3, .ParentID = 1, .Name = "John C. Powell", .Department = "Operations", .Position = "Vice President"})
            stuff_Renamed.Add(New Employee() With {.ID = 4, .ParentID = 1, .Name = "Christian P. Laclair", .Department = "Production", .Position = "Vice President"})
            stuff_Renamed.Add(New Employee() With {.ID = 5, .ParentID = 1, .Name = "Karen J. Kelly", .Department = "Finance", .Position = "Vice President"})

            stuff_Renamed.Add(New Employee() With {.ID = 6, .ParentID = 2, .Name = "Brian C. Cowling", .Department = "Marketing", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 7, .ParentID = 2, .Name = "Thomas C. Dawson", .Department = "Marketing", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 8, .ParentID = 2, .Name = "Angel M. Wilson", .Department = "Marketing", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 9, .ParentID = 2, .Name = "Bryan R. Henderson", .Department = "Marketing", .Position = "Manager"})

            stuff_Renamed.Add(New Employee() With {.ID = 10, .ParentID = 3, .Name = "Harold S. Brandes", .Department = "Operations", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 11, .ParentID = 3, .Name = "Michael S. Blevins", .Department = "Operations", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 12, .ParentID = 3, .Name = "Jan K. Sisk", .Department = "Operations", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 13, .ParentID = 3, .Name = "Sidney L. Holder", .Department = "Operations", .Position = "Manager"})

            stuff_Renamed.Add(New Employee() With {.ID = 14, .ParentID = 4, .Name = "James L. Kelsey", .Department = "Production", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 15, .ParentID = 4, .Name = "Howard M. Carpenter", .Department = "Production", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 16, .ParentID = 4, .Name = "Jennifer T. Tapia", .Department = "Production", .Position = "Manager"})

            stuff_Renamed.Add(New Employee() With {.ID = 17, .ParentID = 5, .Name = "Judith P. Underhill", .Department = "Finance", .Position = "Manager"})
            stuff_Renamed.Add(New Employee() With {.ID = 18, .ParentID = 5, .Name = "Russell E. Belton", .Department = "Finance", .Position = "Manager"})
            Return stuff_Renamed
        End Function
    End Class
End Namespace

Employees.cs

using System;
using System.Collections.Generic;

namespace TreeList_DataBinding {

    public class Employee {
        public int ID { get; set; }
        public int ParentID { get; set; }
        public string Name { get; set; }
        public string Position { get; set; }
        public string Department { get; set; }
    }

    public static class Stuff {
        public static List<Employee> GetStuff() {
            List<Employee> stuff = new List<Employee>();
            stuff.Add(new Employee() { ID = 1, ParentID = 0, Name = "Gregory S. Price", Department = "", Position = "President" });
            stuff.Add(new Employee() { ID = 2, ParentID = 1, Name = "Irma R. Marshall", Department = "Marketing", Position = "Vice President" });
            stuff.Add(new Employee() { ID = 3, ParentID = 1, Name = "John C. Powell", Department = "Operations", Position = "Vice President" });
            stuff.Add(new Employee() { ID = 4, ParentID = 1, Name = "Christian P. Laclair", Department = "Production", Position = "Vice President" });
            stuff.Add(new Employee() { ID = 5, ParentID = 1, Name = "Karen J. Kelly", Department = "Finance", Position = "Vice President" });

            stuff.Add(new Employee() { ID = 6, ParentID = 2, Name = "Brian C. Cowling", Department = "Marketing", Position = "Manager" });
            stuff.Add(new Employee() { ID = 7, ParentID = 2, Name = "Thomas C. Dawson", Department = "Marketing", Position = "Manager" });
            stuff.Add(new Employee() { ID = 8, ParentID = 2, Name = "Angel M. Wilson", Department = "Marketing", Position = "Manager" });
            stuff.Add(new Employee() { ID = 9, ParentID = 2, Name = "Bryan R. Henderson", Department = "Marketing", Position = "Manager" });

            stuff.Add(new Employee() { ID = 10, ParentID = 3, Name = "Harold S. Brandes", Department = "Operations", Position = "Manager" });
            stuff.Add(new Employee() { ID = 11, ParentID = 3, Name = "Michael S. Blevins", Department = "Operations", Position = "Manager" });
            stuff.Add(new Employee() { ID = 12, ParentID = 3, Name = "Jan K. Sisk", Department = "Operations", Position = "Manager" });
            stuff.Add(new Employee() { ID = 13, ParentID = 3, Name = "Sidney L. Holder", Department = "Operations", Position = "Manager" });

            stuff.Add(new Employee() { ID = 14, ParentID = 4, Name = "James L. Kelsey", Department = "Production", Position = "Manager" });
            stuff.Add(new Employee() { ID = 15, ParentID = 4, Name = "Howard M. Carpenter", Department = "Production", Position = "Manager" });
            stuff.Add(new Employee() { ID = 16, ParentID = 4, Name = "Jennifer T. Tapia", Department = "Production", Position = "Manager" });

            stuff.Add(new Employee() { ID = 17, ParentID = 5, Name = "Judith P. Underhill", Department = "Finance", Position = "Manager" });
            stuff.Add(new Employee() { ID = 18, ParentID = 5, Name = "Russell E. Belton", Department = "Finance", Position = "Manager" });
            return stuff;
        }
    }
}

MainWindow.xaml.cs

using System.Windows;

namespace TreeList_DataBinding {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            treeList.ItemsSource = Stuff.GetStuff();
            treeListView1.ExpandAllNodes();
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TreeListControl 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#

calculating-totals-e3273/CS/DXTreeList_Totals/MainWindow.xaml#L7

<Grid>
    <dxg:TreeListControl Name="treeListControl1" AutoPopulateColumns="True">
        <dxg:TreeListControl.View>

how-to-synchronize-the-dxtreelist-with-the-icollectionview-collectionviewsource-e3238/CS/TreeListControlViewModel/MainWindow.xaml#L26

<CheckBox Grid.Row="1" Name="isSyncCheckBox" IsChecked="True" Margin="4,0,0,0">Is Synchronized With Current Item</CheckBox>
<dxg:TreeListControl Margin="4" Grid.Row="2" Grid.Column="0" Name="treeListContol" local:TreeListControlDataModel.CollectionView="{Binding}" local:TreeListControlDataModel.IsSynchronizedWithCurrentItem="{Binding Path=IsChecked, ElementName=isSyncCheckBox}" Height="400">
    <dxg:TreeListControl.View>

iterating-through-nodes-via-tree-traversal-api-e3256/CS/DXTreeList_NodeTraversing/MainWindow.xaml#L9

<Grid>
    <dxg:TreeListControl Name="treeListControl1" Loaded="treeListControl1_Loaded" >
        <dxg:TreeListControl.Columns>

how-to-show-check-boxes-near-nodes-and-check-child-nodes-when-a-parent-node-is-checked-e3466/CS/HierarchicalDataBinding/MainWindow.xaml#L16

<Grid>
    <dxg:TreeListControl x:Name="treeList" ItemsSource="{Binding DataItems}" DataContext="{StaticResource viewModel}">
        <dxg:TreeListControl.Columns>

how-to-implement-the-drag-and-drop-capability-to-move-a-row-from-one-group-to-another-e3645/CS/Q356907/MainWindow.xaml#L8

<Grid>
    <dxg:TreeListControl x:Name="grid" AllowDrop="True">
        <dxg:TreeListControl.Columns>

Inheritance

Show 11 items

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

DataControlBase

DevExpress.Xpf.Grid.GridDataControlBase

TreeListControlBase

TreeListControl

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)