GridColumnTotal.TotalType Property

Gets or sets the summary function type used to calculate a total for the Grid column.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(GridColumnTotalType.Count)]
public GridColumnTotalType TotalType { get; set; }

VB.NET

<DefaultValue(GridColumnTotalType.Count)>
Public Property TotalType As GridColumnTotalType

Property Value

Type	Default	Description
GridColumnTotalType	**Count**	A GridColumnTotalType enumeration value specifying the total type.

Available values:

Name	Description
Auto	The total is calculated based on values of the corresponding data field from the underlying data source. In this case, the Measure.SummaryType property value is taken into account to calculate the total.
Count	The number of records.
Min	The minimum value in a column.
Max	The maximum value in a column.
Avg	The average value of a column.
Sum	The sum of all values in a column.

Remarks

You can calculate totals for all types of grid columns (GridColumnBase descendants), but each column type supports only a specified set of summary functions used to calculate totals. The table below lists the total types supported by different grid columns.

Column Type	Supported Total Types
GridMeasureColumn	All types listed in the GridColumnTotalType enumeration.
GridDimensionColumn	GridColumnTotalType.Min GridColumnTotalType.Max GridColumnTotalType.Count
GridDeltaColumn	GridColumnTotalType.Count
GridSparklineColumn	GridColumnTotalType.Count

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TotalType 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-recalculate-totals/CS/WinFormsDashboard_RecalculateTotals/Classes/RecalculateGridTotalsModule.cs#L77

gridcolumn.Summary.Add(gridSummaryItem);
gridSummaryItem.SummaryType = DashboardTotalsHelper.GetGridColumnTotalType(total.TotalType);
gridSummaryItem.DisplayFormat = total.TotalType != GridColumnTotalType.Auto ?

VB.NET

winforms-dashboard-recalculate-totals/VB/WinFormsDashboard_RecalculateTotals/Classes/RecalculateGridTotalsModule.vb#L78

gridcolumn.Summary.Add(gridSummaryItem)
gridSummaryItem.SummaryType = DashboardTotalsHelper.GetGridColumnTotalType(total.TotalType)
gridSummaryItem.DisplayFormat = If(total.TotalType <> GridColumnTotalType.Auto, String.Format("{0} = {1}", DashboardTotalsHelper.GetTotalPrefix(total.TotalType), FormatHelper.Format(dataItemDescriptor, gridSummaryItem.SummaryValue)), "Auto: Not Supported")