Class
AggregateFunction

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

Definition

Namespace:Telerik.Windows.Data

Assembly:Telerik.Windows.Data.dll

Syntax:

cs-api-definition
public abstract class AggregateFunction : INotifyPropertyChanged

Inheritance: objectAggregateFunction

Derived Classes: AggregateFunction<TElement, TResult>EnumerableAggregateFunctionBase

Implements: INotifyPropertyChanged

Constructors

AggregateFunction()

Declaration

cs-api-definition
protected AggregateFunction()

Properties

Caption

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

Declaration

cs-api-definition
public string Caption { get; set; }

Property Value

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

cs-api-definition
public virtual string FunctionName { get; set; }

Property Value

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

cs-api-definition
public virtual string ResultFormatString { get; set; }

Property Value

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

cs-api-definition
public abstract Expression CreateAggregateExpression(Expression enumerableExpression)

Parameters

enumerableExpression

Expression

The grouping expression.

Returns

Expression

GenerateFunctionName()

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

Declaration

cs-api-definition
protected virtual string GenerateFunctionName()

Returns

string

Function name generated with the following pattern: {GetType().Name}_{GetHashCode()}.

Merge(object, AggregateResultMergeAction, AggregateResult, QueryableCollectionViewGroup)

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

Declaration

cs-api-definition
public virtual object Merge(object item, AggregateResultMergeAction mergeAction, AggregateResult originalAggregateResult, QueryableCollectionViewGroup group)

Parameters

item

object

The item.

mergeAction

AggregateResultMergeAction

The action.

originalAggregateResult

AggregateResult

The original aggregate result.

group

QueryableCollectionViewGroup

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

Returns

object

The new value of the aggregate result.

OnPropertyChanged(string)

Raise PropertyChanged Event.

Declaration

cs-api-definition
protected virtual void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

The property name.

Events

PropertyChanged

Occurs when a property value changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged