Documentation

Class QueryablePropertyAggregateDescriptionBase

Represents an abstraction of an aggregate descriptor, which aggregates by PropertyName.

Inheritance
System.Object
Cloneable
SettingsNode
DescriptionBase
AggregateDescriptionBase
QueryableAggregateDescriptionBase
QueryableAggregateDescription
QueryablePropertyAggregateDescriptionBase
QueryablePropertyAggregateDescription
Inherited Members
Namespace: Telerik.Pivot.Queryable
Assembly: Telerik.Pivot.DataProviders.Queryable.dll

Syntax

public abstract class QueryablePropertyAggregateDescriptionBase : QueryableAggregateDescription, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed, ITotalFormatHost, IDescriptionsReferencing, IStringFormattableAggregate, IInitializeDescription, IAggregateFunctionHost, IDataFieldDescription

Constructors

QueryablePropertyAggregateDescriptionBase()

Declaration
protected QueryablePropertyAggregateDescriptionBase()

Properties

AggregateFunction

Gets or sets the aggregate function that will be used for summary calculation.

Declaration
public QueryableAggregateFunction AggregateFunction { get; set; }
Property Value
QueryableAggregateFunction

Aggregation function.

AggregateMethodName

Gets the name of the aggregate method on the ExtensionMethodsType that will be used for aggregation.

Declaration
protected override string AggregateMethodName { get; }
Property Value
System.String

The name of the aggregate method that will be used.
Overrides

DataType

Provides the data type of the aggregate description.

Declaration
protected Type DataType { get; }
Property Value
System.Type

IgnoreNullValues

Gets or sets a value that determines whether the QueryableAggregateFunctions of this QueryablePropertyAggregateDescriptionBase will ignore null values when calculating the result.

Declaration
public bool IgnoreNullValues { get; set; }
Property Value
System.Boolean

PropertyName

Gets or sets a value identifying a property on the grouped items.

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

SupportedAggregateFunctions

Gets a list of suitable functions for the QueryablePropertyAggregateDescriptionBase.

Declaration
protected virtual IEnumerable<object> SupportedAggregateFunctions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.Object>

Methods

CloneCore(Cloneable)

Makes the instance a clone (deep copy) of the specified Cloneable.

Declaration
protected override void CloneCore(Cloneable source)
Parameters
Cloneable source

The object to clone.
Overrides
Remarks

Notes to Inheritors If you derive from Cloneable, you may need to override this method to copy all properties. It is essential that all implementations call the base implementation of this method (if you don't call base you should manually copy all needed properties including base properties).

CreateAggregateExpression(Expression, String)

Creates the aggregate expression.

Declaration
protected override Expression CreateAggregateExpression(Expression enumerableExpression, string aggregatedValueName)
Parameters
System.Linq.Expressions.Expression enumerableExpression

The grouping expression.
System.String aggregatedValueName

TODO: finish this.
Returns
System.Linq.Expressions.Expression

Overrides

CreateAggregateValueExpression(ParameterExpression)

Creates the aggregate expression.

Declaration
protected override Expression CreateAggregateValueExpression(ParameterExpression itemExpression)
Parameters
System.Linq.Expressions.ParameterExpression itemExpression

TODO: finish this.
Returns
System.Linq.Expressions.Expression

Overrides

GenerateFunctionName()

Generates identification string for this function using AggregateMethodName.

Declaration
protected override string GenerateFunctionName()
Returns
System.String

Function identification string.
Overrides

GetDisplayName()

Gets the display-friendly name.

Declaration
protected override string GetDisplayName()
Returns
System.String

A System.String name.
Overrides

GetUniqueName()

Returns the member name for this description.

Declaration
public override string GetUniqueName()
Returns
System.String

Overrides

Extension Methods