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.v21.1.dll

Declaration

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

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.

TreeListColumn.RowFooterSummary

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:

TreeListColumn.RowFooterSummary

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