Back to all docs
API Reference / Telerik.Pivot.Queryable / QueryablePropertyAggregateDescriptionBase

Class
QueryablePropertyAggregateDescriptionBase

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

Definition

Namespace:Telerik.Pivot.Queryable

Assembly:Telerik.Pivot.DataProviders.Queryable.dll

Syntax:
cs-api-definition
[DataContract]
public abstract class QueryablePropertyAggregateDescriptionBase : QueryableAggregateDescription, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed

Inheritance: objectCloneableSettingsNodeDescriptionBaseAggregateDescriptionBaseQueryableAggregateDescriptionBaseQueryableAggregateDescriptionQueryablePropertyAggregateDescriptionBase

Derived Classes: QueryablePropertyAggregateDescription

Implements: IAggregateDescriptionIDescriptionBaseIEditableINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members QueryableAggregateDescription.FunctionNameQueryableAggregateDescription.ExtensionMethodsTypeQueryableAggregateDescriptionBase.StringFormatQueryableAggregateDescriptionBase.StringFormatSelectorAggregateDescriptionBase.TotalFormatAggregateDescriptionBase.DisplayValueAsKpiDescriptionBase.DisplayNameDescriptionBase.CustomNameSettingsNode.NotifyServicesChanged()SettingsNode.NotifySettingsChanged(SettingsChangedEventArgs)SettingsNode.OnSettingsChanged(SettingsChangedEventArgs)SettingsNode.BeginEdit()SettingsNode.BeginInit()SettingsNode.EndInit()SettingsNode.GetService(Type)SettingsNode.OnPropertyChanged(string)SettingsNode.RemoveSettingsChild(SettingsNode)SettingsNode.AddSettingsChild(SettingsNode)SettingsNode.GetServiceOverride(Type)SettingsNode.OnEnteredEditScope()SettingsNode.OnExitingEditScope()SettingsNode.ParentSettingsNode.SettingsChangedSettingsNode.ServicesChangedSettingsNode.PropertyChangedCloneable.Clone()Cloneable.CreateInstanceCore()

Constructors

QueryablePropertyAggregateDescriptionBase()

Declaration

cs-api-definition
protected QueryablePropertyAggregateDescriptionBase()

Properties

AggregateFunction

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

Declaration

cs-api-definition
[DataMember]
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

cs-api-definition
protected override string AggregateMethodName { get; }

Property Value

string

The name of the aggregate method that will be used.

Overrides QueryableAggregateDescription.AggregateMethodName

DataType

Provides the data type of the aggregate description.

Declaration

cs-api-definition
protected Type DataType { get; }

Property Value

Type

IgnoreNullValues

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

Declaration

cs-api-definition
[DataMember]
public bool IgnoreNullValues { get; set; }

Property Value

bool

PropertyName

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

Declaration

cs-api-definition
[DataMember]
public string PropertyName { get; set; }

Property Value

string

SupportedAggregateFunctions

Gets a list of suitable functions for the QueryablePropertyAggregateDescriptionBase.

Declaration

cs-api-definition
protected virtual IEnumerable<object> SupportedAggregateFunctions { get; }

Property Value

IEnumerable<object>

Methods

CloneCore(Cloneable)

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

Declaration

cs-api-definition
protected override void CloneCore(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Overrides QueryableAggregateDescriptionBase.CloneCore(Cloneable)

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

cs-api-definition
protected override Expression CreateAggregateExpression(Expression enumerableExpression, string aggregatedValueName)

Parameters

enumerableExpression

Expression

The grouping expression.

aggregatedValueName

string

TODO: finish this.

Returns

Expression

Overrides QueryableAggregateDescription.CreateAggregateExpression(Expression, string)

CreateAggregateValueExpression(ParameterExpression)

Creates the aggregate expression.

Declaration

cs-api-definition
protected override Expression CreateAggregateValueExpression(ParameterExpression itemExpression)

Parameters

itemExpression

ParameterExpression

TODO: finish this.

Returns

Expression

Overrides QueryableAggregateDescription.CreateAggregateValueExpression(ParameterExpression)

GenerateFunctionName()

Generates identification string for this function using AggregateMethodName.

Declaration

cs-api-definition
protected override string GenerateFunctionName()

Returns

string

Function identification string.

Overrides QueryableAggregateDescription.GenerateFunctionName()

GetDisplayName()

Gets the display-friendly name.

Declaration

cs-api-definition
protected override string GetDisplayName()

Returns

string

A string name.

Overrides DescriptionBase.GetDisplayName()

GetUniqueName()

Returns the member name for this description.

Declaration

cs-api-definition
public override string GetUniqueName()

Returns

string

Overrides DescriptionBase.GetUniqueName()

In this article
DefinitionConstructorsQueryablePropertyAggregateDescriptionBase()PropertiesAggregateFunctionAggregateMethodNameDataTypeIgnoreNullValuesPropertyNameSupportedAggregateFunctionsMethodsCloneCore(Cloneable)CreateAggregateExpression(Expression, string)CreateAggregateValueExpression(ParameterExpression)GenerateFunctionName()GetDisplayName()GetUniqueName()
Not finding the help you need?
Contact Support