XRSummary.Running Property

Gets or sets a value specifying a report area, for which the arithmetic function is calculated.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

public virtual SummaryRunning Running { get; set; }
Public Overridable Property Running As SummaryRunning

Property Value

Type Description
SummaryRunning

A SummaryRunning enumeration value.

The set of possible values for this property is available at SummaryRunning, and the arithmetic function to be calculated is set by the XRSummary.Func property.

If this property is set to the SummaryRunning.Report, a label always displays the function value calculated for the entire report.

If this property is set to the SummaryRunning.Page, a label always displays the function value calculated for the current page where the label is printed.

If this property is set to the SummaryRunning.Group, the displayed result depends on the band where the label is positioned:

Examples

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 containing a numerical value.

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 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;
}

See Also