TreeListColumn.RowFooterSummary Property

Specifies the type of summary calculated against child nodes for every parent node in the current column.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

C#

[DefaultValue(SummaryItemType.None)]
[XtraSerializableProperty]
public SummaryItemType RowFooterSummary { get; set; }

VB.NET

<DefaultValue(SummaryItemType.None)>
<XtraSerializableProperty>
Public Property RowFooterSummary As SummaryItemType

Property Value

Type	Default	Description
SummaryItemType	**None**	A SummaryItemType enumerator value.

Available values:

Name	Description
Sum	Calculates the sum of field values within a group of column cells.
Min	Retrieves the minimum value within a group of column cells.
Max	Retrieves the maximum value within a group of column cells.
Count	Calculates the number of nodes within a group of column cells.
Average	Calculates the average field value within a group of column cells.
Custom	Allows a user to define a custom summary value by handling the TreeList.GetCustomSummaryValue event.
None	Summary is not calculated.

Remarks

The RowFooterSummary property defines the type of summary to calculate against column cells of child nodes, for every node that has nesting nodes. These summaries are displayed in group footers below the last child nodes in each group. You need to enable the TreeListOptionsView.ShowRowFooterSummary option to display group footers.

The summary format is determined by the TreeListColumn.RowFooterSummaryStrFormat string.

To calculate summaries against root nodes or all nodes in the Tree List control, use the TreeListColumn.SummaryFooter property.

Note

Group footers are forcibly hidden when filtering is applied in Smart mode (see TreeListOptionsFilter.FilterMode).

Example

The following example demonstrates how to apply a group summary to the Tree List control. The TreeListColumn.RowFooterSummary and TreeListColumn.RowFooterSummaryStrFormat properties are used to set the function type and apply formatting to summary values. The TreeListOptionsView.ShowRowFooterSummary option is enabled to display row footers.

The following image shows the result:

C#

treeList1.OptionsView.ShowRowFooterSummary = true;
treeList1.Columns["Budget"].RowFooterSummary = SummaryItemType.Sum;
treeList1.Columns["Budget"].RowFooterSummaryStrFormat = "Budget Total {0:c}";

VB.NET

TreeList1.OptionsView.ShowRowFooterSummary = True
TreeList1.Columns("Budget").RowFooterSummary = SummaryItemType.Sum
TreeList1.Columns("Budget").RowFooterSummaryStrFormat = "Budget Total {0:c}"

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RowFooterSummary 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#

row-group-summary-how-to-handle-row-footer-visibility-t192034/CS/dxSample/Form1.cs#L25

void InitSummary(){
    treeList1.Columns[1].RowFooterSummary = DevExpress.XtraTreeList.SummaryItemType.Sum;
    treeList1.Columns[2].RowFooterSummary = DevExpress.XtraTreeList.SummaryItemType.Count;

VB.NET

row-group-summary-how-to-handle-row-footer-visibility-t192034/VB/dxSample/Form1.vb#L27

Private Sub InitSummary()
    treeList1.Columns(1).RowFooterSummary = DevExpress.XtraTreeList.SummaryItemType.Sum
    treeList1.Columns(2).RowFooterSummary = DevExpress.XtraTreeList.SummaryItemType.Count