TreeList.DataSource Property

Gets or sets the data source for the current TreeList control.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v23.2.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#

public object DataSource { get; set; }

VB.NET

Public Property DataSource As Object

Property Value

Type	Description
Object	The data source object.

Remarks

You can bind all traditional data sources to the Tree List control: BindingSource, BindingList<T>, DataTable, DataView, IBindingList, IList, etc. In bound mode, the Tree List control creates nodes for all records in the data source at one time, when it loads data. It does not load data dynamically in this mode.

Because of the data source’s tree-like structure, the Tree List control implements a specific sorting algorithm. Therefore you cannot use the data source’s functionality in order to sort data. Use the XtraTreeList’s methods instead (for example, the TreeListColumn.SortOrder property).

The code sample below illustrates how to populate a tree list with random values.

C#

treeList1.DataSource = CreateTLData(100);

DataTable CreateTLData(int recordCount)
{
    Random rnd = new Random();
    DataTable tbl = new DataTable();
    tbl.Columns.Add("ID", typeof(int));
    tbl.Columns.Add("ParentID", typeof(int));
    tbl.Columns.Add("Name", typeof(string));
    tbl.Columns.Add("Date", typeof(DateTime));
    tbl.Columns.Add("Checked", typeof(bool));
    for (int i = 0; i < recordCount; i++)
        tbl.Rows.Add(new object[] { i, rnd.Next(20), String.Format("Name{0}", i), DateTime.Now.Date.AddDays(rnd.Next(-250, 250)), rnd.Next(2) == 0 });
    return tbl;
}

VB.NET

treeList1.DataSource = CreateTLData(100)

DataTable CreateTLData(Integer recordCount)
    Dim rnd As New Random()
    Dim tbl As New DataTable()
    tbl.Columns.Add("ID", GetType(Integer))
    tbl.Columns.Add("ParentID", GetType(Integer))
    tbl.Columns.Add("Name", GetType(String))
    tbl.Columns.Add("Date", GetType(Date))
    tbl.Columns.Add("Checked", GetType(Boolean))
    For i As Integer = 0 To recordCount - 1
        tbl.Rows.Add(New Object() { i, rnd.Next(20), String.Format("Name{0}", i), Date.Now.Date.AddDays(rnd.Next(-250, 250)), rnd.Next(2) = 0 })
    Next i
    Return tbl

Related GitHub Examples

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

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L78

skipMasterFiltering = true;
tree.DataSource = null;
tree.ParentFieldName = tree.KeyFieldName = string.Empty;

winforms-treelist-virtual-mode/CS/ExampleMainForm.cs#L31

    MyTtreeList.SelectImageList = imageListForTree;
    MyTtreeList.DataSource = new object();
}

winforms-coloredit-display-knowncolor-for-argb-colors/CS/WindowsApplication78/Form1.cs#L33

    treeListColumn1.ColumnEdit = ri;
    treeList1.DataSource = dt;
}

winforms-treelist-expression-editor-xpview/CS/E1887/Form1.cs#L33

private void OnFormLoad(object sender, EventArgs e) {
    treeList1.DataSource = xpView1;
}

winforms-treelist-display-numbers-in-node-indicator/CS/WindowsApplication1/Form1.cs#L33

    InitializeComponent();
    treeList1.DataSource = CreateTable();
}

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L85

skipMasterFiltering = True
tree.DataSource = Nothing
tree.KeyFieldName = String.Empty

winforms-treelist-virtual-mode/VB/ExampleMainForm.vb#L23

    MyTtreeList.SelectImageList = imageListForTree
    MyTtreeList.DataSource = New Object()
End Sub

winforms-coloredit-display-knowncolor-for-argb-colors/VB/WindowsApplication78/Form1.vb#L28

    treeListColumn1.ColumnEdit = ri
    treeList1.DataSource = dt
End Sub

winforms-treelist-expression-editor-xpview/VB/E1887/Form1.vb#L33

Private Sub OnFormLoad(ByVal sender As Object, ByVal e As EventArgs)
    treeList1.DataSource = xpView1
End Sub

winforms-treelist-display-numbers-in-node-indicator/VB/WindowsApplication1/Form1.vb#L31

    InitializeComponent()
    treeList1.DataSource = CreateTable()
End Sub