TreeListMenuItemClickEventArgs.SummaryType Property

Gets or sets the summary type which is about to be applied to the column.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v21.1.dll

Declaration

public SummaryItemType SummaryType { get; set; }

Property Value

Type Description
SummaryItemType

A SummaryItemType enumeration value specifying the type of summary which is about to be applied to the column.

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

Use the SummaryType property to determine the type of summary that a user is going to apply via a menu item click. This property also allows you to specify custom summary type applied to the column where the menu has been activated. The TreeListMenuItemClickEventArgs.SummaryFormat property can be used to format summary values according to the specified summary type.

Use the TreeListMenuItemClickEventArgs.IsFooter and TreeListMenuItemClickEventArgs.MenuType properties to determine whether the footer or row footer summary is being applied. The column to which a summary is applied can be obtained via the TreeListMenuItemClickEventArgs.Column property.

Note: the TreeListMenuItemClickEventArgs.Handled property value must be set to false to allow for the summary.

See Also