PivotGridFieldSortBySummaryInfo.CustomTotalSummaryType Property

Gets or sets the summary type of the custom total column/row, by which the current field values are sorted.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.2.Core.dll

Declaration

C#

[DefaultValue(null)]
public PivotSummaryType? CustomTotalSummaryType { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property CustomTotalSummaryType As PivotSummaryType?

Property Value

Type	Default	Description
Nullable<PivotSummaryType>	null	A PivotSummaryType object representing the summary type of the custom total column/row, by which the field values are sorted. Null if the field values are not sorted by a custom total column/row.

Available values:

Show 13 items

Name	Description
Count	The number of values (excluding Null and DBNull values).
Sum	The sum of the values.
Min	The smallest value.
Max	The largest value.
Average	The average of the values.
StdDev	An estimate of the standard deviation of a population, where the sample is a subset of the entire population.
StdDevp	The standard deviation of a population, where the population is all of the data to be summarized.
Var	An estimate of the variance of a population, where the sample is a subset of the entire population.
Varp	The variance of a population, where the population is all of the data to be summarized.
Custom	Specifies whether calculations should be performed manually, by handling the CustomSummary event. Not supported in OLAP and server mode.
CountDistinct	The number of distinct values. This function works only in the Optimized mode.
Median	The median of the values. A median is the number separating the higher half of a value range from the lower half. This function works only in the Optimized mode.
Mode	The mode of the values. A mode is the value that is repeated more often than any other. This function works only in the Optimized mode.

Remarks

The CustomTotalSummaryType property is in effect when the field values are sorted by a custom total column/row. In this instance, this property specifies the summary type of the custom total. Otherwise, the CustomTotalSummaryType property is set to null.

To apply sorting by summary to the field, use the PivotGridFieldBase.SetSortBySummary method.