Class
AggregateFunction

Represents an aggregate function.

Definition

Namespace:Telerik.DataSource

Assembly:Telerik.DataSource.dll

Syntax:

cs-api-definition
[JsonConverter(typeof(AggregateFunctionConverter))]
public abstract class AggregateFunction : JsonObject

Inheritance: objectJsonObjectAggregateFunction

Inherited Members JsonObject.ToJson()

Constructors

AggregateFunction()

Declaration

cs-api-definition
protected AggregateFunction()

Properties

AggregateMethodName

Declaration

cs-api-definition
public abstract string AggregateMethodName { get; }

Property Value

string

Caption

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

Declaration

cs-api-definition
[JsonIgnore]
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
[JsonIgnore]
public virtual string FunctionName { get; set; }

Property Value

string

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

MemberType

The type of the field

Declaration

cs-api-definition
[JsonIgnore]
public Type MemberType { get; set; }

Property Value

Type

ResultFormatString

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

Declaration

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

Property Value

string

The format string.

SourceField

Gets or sets the name of the field, of the item from the set of items, which value is used as the argument of the aggregate function.

Declaration

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

Property Value

string

The name of the field to get the argument value from.

Methods

CreateAggregateExpression(Expression, bool)

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, bool liftMemberAccessToNull)

Parameters

enumerableExpression

Expression

The grouping expression.

liftMemberAccessToNull

bool

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()}

Serialize(IDictionary<string, object>)

Serializes the provided dictionary.

Declaration

cs-api-definition
protected override void Serialize(IDictionary<string, object> json)

Parameters

json

IDictionary<string, object>

Overrides JsonObject.Serialize(IDictionary<string, object>)