TreeListSummaryItem Class

A summary item.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public class TreeListSummaryItem :
    SummaryItemBase

VB.NET

Public Class TreeListSummaryItem
    Inherits SummaryItemBase

Related API Members

The following members return TreeListSummaryItem objects:

• TreeListNodeSummaryItemCollection.Add(SummaryItemType, String)

Remarks

The DXTreeList allows you to display concise information about individual columns. For instance, you can display the total number of nodes or maximum value, etc. This is called a summary.

The DXTreeList supports the Total Summary type. It stores total summary items within the DevExpress.Xpf.Grid.TreeListControl.TotalSummary collection. Individual summary items are represented by the TreeListSummaryItem objects.

To learn more, see Data Summaries.

Example

This example shows how to display totals. It is shown how to create summary items in code-behind and XAML.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/calculating-totals-e3273.

MainWindow.xaml

<Window x:Class="DXTreeList_Totals.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"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid">
    <Grid>
        <dxg:TreeListControl Name="treeListControl1" AutoPopulateColumns="True">
            <dxg:TreeListControl.View>
                <dxg:TreeListView Name="treeListView1" AutoWidth="True"
                                  KeyFieldName="ID" ParentFieldName="ParentID"
                                  ShowTotalSummary="True"/>
            </dxg:TreeListControl.View>
            <dxg:TreeListControl.TotalSummary>
                <dxg:TreeListSummaryItem FieldName="Name" SummaryType="Count" />
            </dxg:TreeListControl.TotalSummary>
        </dxg:TreeListControl>
    </Grid>
</Window>

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Windows
Imports DevExpress.Data
Imports DevExpress.Xpf.Grid

Namespace DXTreeList_Totals
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            treeListControl1.ItemsSource = Stuff.GetStuff()
            treeListControl1.View.ExpandAllNodes()
            CreateTotal("Age", SummaryItemType.Min)
            CreateTotal("Age", SummaryItemType.Max)
            CreateTotal("Age", SummaryItemType.Average)
        End Sub

        Private Sub CreateTotal(ByVal fieldName As String, ByVal summaryType As SummaryItemType)
            Dim total As New TreeListSummaryItem() With {.FieldName = fieldName, .SummaryType = summaryType, .ShowInColumn = fieldName}
            treeListControl1.TotalSummary.Add(total)
        End Sub
    End Class
End Namespace

Employees.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic

Namespace DXTreeList_Totals

    Public Class Employee
        Private privateID As Integer
        Public Property ID() As Integer
            Get
                Return privateID
            End Get
            Set(ByVal value As Integer)
                privateID = value
            End Set
        End Property
        Private privateParentID As Integer
        Public Property ParentID() As Integer
            Get
                Return privateParentID
            End Get
            Set(ByVal value As Integer)
                privateParentID = value
            End Set
        End Property
        Private privateName As String
        Public Property Name() As String
            Get
                Return privateName
            End Get
            Set(ByVal value As String)
                privateName = value
            End Set
        End Property
        Private privatePosition As String
        Public Property Position() As String
            Get
                Return privatePosition
            End Get
            Set(ByVal value As String)
                privatePosition = value
            End Set
        End Property
        Private privateDepartment As String
        Public Property Department() As String
            Get
                Return privateDepartment
            End Get
            Set(ByVal value As String)
                privateDepartment = value
            End Set
        End Property
        Private privateAge As Integer
        Public Property Age() As Integer
            Get
                Return privateAge
            End Get
            Set(ByVal value As Integer)
                privateAge = value
            End Set
        End Property
    End Class

    Public NotInheritable Class Stuff
        Private Sub New()
        End Sub
        Public Shared Function GetStuff() As List(Of Employee)
            Dim stuff As New List(Of Employee)()
            stuff.Add(New Employee() With {.ID = 1, .ParentID = 0, .Name = "Gregory S. Price", .Department = "", .Position = "President", .Age = 57})
            stuff.Add(New Employee() With {.ID = 2, .ParentID = 1, .Name = "Irma R. Marshall", .Department = "Marketing", .Position = "Vice President", .Age = 45})
            stuff.Add(New Employee() With {.ID = 3, .ParentID = 1, .Name = "John C. Powell", .Department = "Operations", .Position = "Vice President", .Age = 43})
            stuff.Add(New Employee() With {.ID = 4, .ParentID = 1, .Name = "Christian P. Laclair", .Department = "Production", .Position = "Vice President", .Age = 38})
            stuff.Add(New Employee() With {.ID = 5, .ParentID = 1, .Name = "Karen J. Kelly", .Department = "Finance", .Position = "Vice President", .Age = 55})

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

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

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

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

MainWindow.xaml.cs

using System.Windows;
using DevExpress.Data;
using DevExpress.Xpf.Grid;

namespace DXTreeList_Totals {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            treeListControl1.ItemsSource = Stuff.GetStuff();
            treeListControl1.View.ExpandAllNodes();
            CreateTotal("Age", SummaryItemType.Min);
            CreateTotal("Age", SummaryItemType.Max);
            CreateTotal("Age", SummaryItemType.Average);
        }

        private void CreateTotal(string fieldName, SummaryItemType summaryType) {
            TreeListSummaryItem total = new TreeListSummaryItem() {
                FieldName = fieldName,
                SummaryType = summaryType,
                ShowInColumn = fieldName
            };
            treeListControl1.TotalSummary.Add(total);
        }
    }
}

Employees.cs

using System;
using System.Collections.Generic;

namespace DXTreeList_Totals {

    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 int Age { 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", Age = 57 });
            stuff.Add(new Employee() { ID = 2, ParentID = 1, Name = "Irma R. Marshall", Department = "Marketing", Position = "Vice President", Age = 45 });
            stuff.Add(new Employee() { ID = 3, ParentID = 1, Name = "John C. Powell", Department = "Operations", Position = "Vice President", Age = 43 });
            stuff.Add(new Employee() { ID = 4, ParentID = 1, Name = "Christian P. Laclair", Department = "Production", Position = "Vice President", Age = 38 });
            stuff.Add(new Employee() { ID = 5, ParentID = 1, Name = "Karen J. Kelly", Department = "Finance", Position = "Vice President", Age = 55 });

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

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

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

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

Related GitHub Examples

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

dxtreelist-how-to-implement-summary-footers-e4793/CS/MainWindow.xaml#L32

<dxg:TreeListControl.TotalSummary>
    <dxg:TreeListSummaryItem FieldName="Id" SummaryType="Sum"/>
    <dxg:TreeListSummaryItem FieldName="Id" SummaryType="Count"/>

how-to-show-node-summaries-in-treelistview-t506323/CS/TreeList_DataBinding/MainWindow.xaml#L28

<dxg:TreeListView.NodeSummary>
    <dxg:TreeListSummaryItem FieldName="Statistics" SummaryType="Average" ShowInColumn="Statistics"/>
    <dxg:TreeListSummaryItem FieldName="Name" SummaryType="Count" ShowInColumn="Name"/>

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

<dxg:TreeListControl.TotalSummary>
    <dxg:TreeListSummaryItem FieldName="Name" SummaryType="Count" />
</dxg:TreeListControl.TotalSummary>

how-to-calculate-custom-node-summaries-in-treelistview-t506349/CS/TreeList_DataBinding/MainWindow.xaml#L28

<dxg:TreeListView.NodeSummary>
    <dxg:TreeListSummaryItem FieldName="Statistics" SummaryType="Custom" ShowInColumn="Statistics"/>
</dxg:TreeListView.NodeSummary>

how-to-show-node-summaries-based-on-a-source-collection-t506283/CS/TreeList_DataBinding/MainWindow.xaml#L16

<ContentControl>
    <dxg:TreeListSummaryItem FieldName="{Binding Path=(dxi:DependencyObjectExtensions.DataContext).FieldName, RelativeSource={RelativeSource Self}}"
                SummaryType="{Binding Path=(dxi:DependencyObjectExtensions.DataContext).Type, RelativeSource={RelativeSource Self}}"/>

Inheritance

Object

DispatcherObject

DependencyObject

SummaryItemBase

TreeListSummaryItem