Documentation

Class AggregateFunction

Represents the basic class that supports creating functions that provide statistical information about a set of items.

Inheritance
System.Object
AggregateFunction
AggregateFunction<TElement, TResult>
EnumerableAggregateFunctionBase
Namespace: Telerik.Windows.Data
Assembly: Telerik.Windows.Data.dll

Syntax

public abstract class AggregateFunction : Object, INotifyPropertyChanged

Constructors

AggregateFunction()

Declaration
protected AggregateFunction()

Properties

Caption

Gets or sets the informative message to display as an illustration of the aggregate function.

Declaration
public string Caption { get; set; }
Property Value
System.String

The caption to display as an illustration of the aggregate function.

FunctionName

Gets or sets the name of the aggregate function, which appears as a property of the group record on which records the function works.

Declaration
public virtual string FunctionName { get; set; }
Property Value
System.String

The name of the function as visible from the group record.

ResultFormatString

Gets or sets a string that is used to format the result value.

Declaration
public virtual string ResultFormatString { get; set; }
Property Value
System.String

The format string.

Methods

CreateAggregateExpression(Expression)

Creates the aggregate expression that is used for constructing expression tree that will calculate the aggregate result.

Declaration
public abstract Expression CreateAggregateExpression(Expression enumerableExpression)
Parameters
System.Linq.Expressions.Expression enumerableExpression

The grouping expression.
Returns
System.Linq.Expressions.Expression

GenerateFunctionName()

Generates default name for this function using this type's name.

Declaration
protected virtual string GenerateFunctionName()
Returns
System.String

Function name generated with the following pattern: {System.Object.GetType.System.Reflection.MemberInfo.Name}_{System.Object.GetHashCode}.

Merge(Object, AggregateResultMergeAction, AggregateResult, QueryableCollectionViewGroup)

Merges the specified item into the aggregate result according to the specified action.

Declaration
public virtual object Merge(object item, AggregateResultMergeAction mergeAction, AggregateResult originalAggregateResult, QueryableCollectionViewGroup group)
Parameters
System.Object item

The item.
AggregateResultMergeAction mergeAction

The action.
AggregateResult originalAggregateResult

The original aggregate result.
QueryableCollectionViewGroup group

The group which the item is being added to or removed from.
Returns
System.Object

The new value of the aggregate result.

OnPropertyChanged(String)

Raise PropertyChanged Event.

Declaration
protected virtual void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

The property name.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Extension Methods