XRSummary.Func Property

Specifies the arithmetic function to calculate.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[DefaultValue(SummaryFunc.Sum)]
public virtual SummaryFunc Func { get; set; }

VB.NET

<DefaultValue(SummaryFunc.Sum)>
Public Overridable Property Func As SummaryFunc

Property Value

Type	Default	Description
SummaryFunc	Sum	A SummaryFunc enumeration value.

Available values:

Show 22 items

Name	Description
Avg	Calculates the average of all the values within the specified summary region (group, page or report).
Count	Counts the number of values within the specified summary region (group, page or report).
Sum	Calculates the total of all the values within the specified summary region (group, page or report).
RunningSum	Summarizes all the values, which were printed before the current data row, with the current data row’s value.
CarryoverSum	Summarizes all the values before the current position and calculates the carried forward and brought forward totals.
Percentage	Calculates the percent ratio of the current data row’s value to the total of all the values within the specified summary region (group, page or report).
Max	Calculates the maximum of all the values within the specified summary region (group, page or report).
Min	Calculates the minimum of all the values within the specified summary region (group, page or report).
Median	Finds the middle number within a sequence. Note that if the total number of elements is odd, this function returns the value of a middle number in a sequence. If the total number of elements is even, this function returns the arithmetical mean of the two middle numbers.
Var	Calculates the amount of variance for all the values within the specified summary region (group, page or report).
VarP	Calculates the population variance of all the values within the specified summary region (group, page or report).
StdDev	Calculates the standard deviation of all the values within the specified summary region (group, page or report).
StdDevP	Calculates the standard population deviation of all the values within the specified summary region (group, page or report).
DAvg	Calculates the average of all the distinct values within the specified summary region (group, page or report).
DCount	Counts the number of distinct values within the specified summary region (group, page or report).
DSum	Calculates the total of all the distinct values within the specified summary region (group, page or report).
DVar	Calculates the amount of variance for all the distinct values within the specified summary region (group, page or report).
DVarP	Calculates the population variance of all the distinct values within the specified summary region (group, page or report).
DStdDev	Calculates the standard deviation of all the distinct values within the specified summary region (group, page or report).
DStdDevP	Calculates the standard population deviation of all the distinct values within the specified summary region (group, page or report).
RecordNumber	Returns the current record number in the data source within the specified summary region (group, page or report). This means for instance, if the summary is calculated for a group, then the record number is calculated only within that group, and is reset every time a new group is started.
Custom	Calculates the custom summary using the XRLabel.SummaryReset, XRLabel.SummaryRowChanged and XRLabel.SummaryGetResult events.

Remarks

The report area, for which the specified arithmetic function is calculated (page, group, or report), is specified by the XRSummary.Running property.

Example

The following example demonstrates how to set summary options for a label at runtime. The method below creates an XRSummary object, sets its properties, and sets the XRLabel.Summary property. This example assumes that there is an already existing XRLabel object, passed as a parameter and bound to a dataset field that contains a numerical value.

C#

using DevExpress.XtraReports.UI;
// ...
public void SetFunction(XRLabel label) {
    // Create an XRSummary object. 
    XRSummary summary = new XRSummary();

    // Set a function which should be calculated. 
    summary.Func = SummaryFunc.Avg;

    // Set a range for which the function should be calculated. 
    summary.Running = SummaryRunning.Group;

    // Set the "ingore null values" option. 
    summary.IgnoreNullValues = true;

    // Set the "treat strings as numerics" option.
    summary.TreatStringsAsNumerics = true;

    // Set the output string format. 
    summary.FormatString = "{0:c2}";

    // Make the label calculate the specified function for the 
    // value specified by its DataBindings.Text property. 
    label.Summary = summary;
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...
Public Sub SetFunction(ByVal label As XRLabel)
    ' Create an XRSummary object. 
    Dim summary As New XRSummary()

    ' Set a function which should be calculated. 
    summary.Func = SummaryFunc.Avg

    ' Set a range for which the function should be calculated. 
    summary.Running = SummaryRunning.Group

    ' Set the "ingore null values" option. 
    summary.IgnoreNullValues = True

    ' Set the "treat strings as numerics" option.
    summary.TreatStringsAsNumerics = True

    ' Set the output string format. 
    summary.FormatString = "{0:c2}"

    ' Make the label calculate the specified function for the 
    ' value specified by its DataBindings.Text property. 
    label.Summary = summary
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Func 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#

asp-net-web-forms-grid-create-report-based-on-grid-layout/CS/WebApplication1/ReportHelper.cs#L73

label.Summary.FormatString = item.DisplayFormat;
label.Summary.Func = GetSummaryFunc(item.SummaryType);
footerBand.Controls.Add(label);

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Models/ReportHelperMVC.cs#L59

label.Summary.FormatString = item.DisplayFormat;
label.Summary.Func = GetSummaryFunc(item.SummaryType);
report.Bands[BandKind.ReportFooter].Controls.Add(label);

VB.NET

asp-net-web-forms-grid-create-report-based-on-grid-layout/VB/WebApplication1/ReportHelper.vb#L75

label.Summary.FormatString = item.DisplayFormat
label.Summary.Func = GetSummaryFunc(item.SummaryType)
footerBand.Controls.Add(label)

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Models/ReportHelperMVC.vb#L56

label.Summary.FormatString = item.DisplayFormat
label.Summary.Func = GetSummaryFunc(item.SummaryType)
report.Bands(BandKind.ReportFooter).Controls.Add(label)