New to Telerik Reporting? Start a free 30-day trial

IAggregateFunction

Interface

Provides custom (user-defined) implementation for aggregate function.

Definition

Namespace:Telerik.Reporting.Expressions

Assembly:Telerik.Reporting.dll

Syntax:

public interface IAggregateFunction

Methods

Accumulate(object[])

Accumulates the passed values in the aggregate.

void Accumulate(object[] values)

Parameters:valuesobject[]

The values that will be accumulated on a single accumulation operation. The length of the values array equals to the number of parameters that the defined aggregate expects (most common one).

GetValue()

object

Gets the value that the aggregate instance keeps currently accumulated.

object GetValue()

Returns:

object

Returns the currently accumulated value.

Init()

Initializes the aggregate function instance. Implement to set the aggregate in its initial state ready to accumulate and merge values.

void Init()

Merges another instance of the same aggregate function into the current instance. Implement this method to allow the reporting engine to merge the two resulting aggregates coming from two subsets of the aggregated data source rows.

void Merge(IAggregateFunction aggregateFunction)

Parameters:aggregateFunctionIAggregateFunction

Another instance of the same aggregate function that will be merged in the current instance.