# C1.C1Preview.DataBinding.Aggregate

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="C1_C1Preview_DataBinding_Aggregate" data-uid="C1.C1Preview.DataBinding.Aggregate" class="text-break">Aggregate Class
</h1>
  <div class="markdown level0 summary"><p>Represents an aggregate value calculated on a data-bound element
of a <a class="xref" href="C1.C1Preview.C1PrintDocument.html">C1PrintDocument</a> over a certain scope.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="C1.C1Preview.NamedCollectionItem.html">NamedCollectionItem</a></div>
    <div class="level2"><span class="xref">Aggregate</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.icloneable">ICloneable</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.C1Preview.DataBinding.html">C1.C1Preview.DataBinding</a></h6>
  <h6><strong>Assembly</strong>: C1.PrintDocument.4.8.dll</h6>
  <h5 id="C1_C1Preview_DataBinding_Aggregate_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[C1ClassSerialization(true)]
public class Aggregate : NamedCollectionItem, ICloneable</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">&lt;C1ClassSerialization(True)&gt;
Public Class Aggregate
    Inherits NamedCollectionItem
    Implements ICloneable</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate__ctor_System_String_" data-uid="C1.C1Preview.DataBinding.Aggregate.#ctor(System.String)">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.-ctor.html#C1_C1Preview_DataBinding_Aggregate__ctor_System_String_">Aggregate(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.html">Aggregate</a> class,
assigning the name of the aggregate.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate__ctor_System_String_System_String_C1_C1Preview_DataBinding_C1DataBinding_C1_C1Preview_DataBinding_RunningEnum_C1_C1Preview_DataBinding_AggregateFuncEnum_" data-uid="C1.C1Preview.DataBinding.Aggregate.#ctor(System.String,System.String,C1.C1Preview.DataBinding.C1DataBinding,C1.C1Preview.DataBinding.RunningEnum,C1.C1Preview.DataBinding.AggregateFuncEnum)">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.-ctor.html#C1_C1Preview_DataBinding_Aggregate__ctor_System_String_System_String_C1_C1Preview_DataBinding_C1DataBinding_C1_C1Preview_DataBinding_RunningEnum_C1_C1Preview_DataBinding_AggregateFuncEnum_">Aggregate(string, string, C1DataBinding, RunningEnum, AggregateFuncEnum)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.html">Aggregate</a> class,
assigning the name, expression, data binding, scope and function of the aggregate.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_DataBinding" data-uid="C1.C1Preview.DataBinding.Aggregate.DataBinding">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.DataBinding.html#C1_C1Preview_DataBinding_Aggregate_DataBinding">DataBinding</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the data binding providing data over which the current aggregate is calculated.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_Expression" data-uid="C1.C1Preview.DataBinding.Aggregate.Expression">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.Expression.html#C1_C1Preview_DataBinding_Aggregate_Expression">Expression</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.C1Preview.DataBinding.Expression.html">Expression</a> object used to calculate the value of the current aggregate.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_ExpressionText" data-uid="C1.C1Preview.DataBinding.Aggregate.ExpressionText">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.ExpressionText.html#C1_C1Preview_DataBinding_Aggregate_ExpressionText">ExpressionText</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the text of the <a class="xref" href="C1.C1Preview.DataBinding.Expression.html">Expression</a> object used to calculate the value of the current aggregate.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_Func" data-uid="C1.C1Preview.DataBinding.Aggregate.Func">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.Func.html#C1_C1Preview_DataBinding_Aggregate_Func">Func</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the function (min, max, average and so on) calculated by the current aggregate.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_IgnoreNullValues" data-uid="C1.C1Preview.DataBinding.Aggregate.IgnoreNullValues">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.IgnoreNullValues.html#C1_C1Preview_DataBinding_Aggregate_IgnoreNullValues">IgnoreNullValues</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether null values should be ignored
when the current aggregate is calculated.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_Owner" data-uid="C1.C1Preview.DataBinding.Aggregate.Owner">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.Owner.html#C1_C1Preview_DataBinding_Aggregate_Owner">Owner</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.C1Preview.DataBinding.AggregateCollection.html">AggregateCollection</a> containing the current aggregate.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_Running" data-uid="C1.C1Preview.DataBinding.Aggregate.Running">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.Running.html#C1_C1Preview_DataBinding_Aggregate_Running">Running</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a <a class="xref" href="C1.C1Preview.DataBinding.RunningEnum.html">RunningEnum</a> value determining the scope of the current aggregate:
whether it is calculated over all records, or separately for each group.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_Value" data-uid="C1.C1Preview.DataBinding.Aggregate.Value">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.Value.html#C1_C1Preview_DataBinding_Aggregate_Value">Value</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the value of the current aggregate, calculating it if it has not been calculated yet
(the calculated value is cached).</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_AssignFrom_C1_C1Preview_NamedCollectionItem_" data-uid="C1.C1Preview.DataBinding.Aggregate.AssignFrom(C1.C1Preview.NamedCollectionItem)">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.AssignFrom.html#C1_C1Preview_DataBinding_Aggregate_AssignFrom_C1_C1Preview_NamedCollectionItem_">AssignFrom(NamedCollectionItem)</a>
        </td>
        <td class="markdown level1 summary"><p>Assigns (copies) properties from another <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.html">Aggregate</a> to the current object.</p>
</td>
      </tr>
      <tr>
        <td id="C1_C1Preview_DataBinding_Aggregate_SetName_System_String_" data-uid="C1.C1Preview.DataBinding.Aggregate.SetName(System.String)">
          <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.SetName.html#C1_C1Preview_DataBinding_Aggregate_SetName_System_String_">SetName(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Sets the name of the current <a class="xref" href="C1.C1Preview.DataBinding.Aggregate.html">Aggregate</a>.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>