New to Telerik UI for WinForms? Start a free 30-day trial

QueryablePropertyAggregateDescriptionBase

Class

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

Definition

Namespace:Telerik.Pivot.Queryable

Assembly:Telerik.WinControls.PivotGrid.dll

Syntax:

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

protected QueryablePropertyAggregateDescriptionBase()

Properties

AggregateMethodName

string

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

protected override string AggregateMethodName { get; }

Property Value:

The name of the aggregate method that will be used.

Overrides: QueryableAggregateDescription.AggregateMethodName

DataType

Type

Provides the data type of the aggregate description.

protected Type DataType { get; }

IgnoreNullValues

bool

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

[DataMember]
public bool IgnoreNullValues { get; set; }

PropertyName

string

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

[DataMember]
public string PropertyName { get; set; }

SupportedAggregateFunctions

IEnumerable<object>

Gets a list of suitable functions for the QueryablePropertyAggregateDescriptionBase.

protected virtual IEnumerable<object> SupportedAggregateFunctions { get; }

Methods

CloneCore(Cloneable)

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

protected override void CloneCore(Cloneable source)

Parameters:sourceCloneable

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.

protected override Expression CreateAggregateExpression(Expression enumerableExpression, string aggregatedValueName)

Parameters:enumerableExpressionExpression

The grouping expression.

aggregatedValueNamestring

TODO: finish this.

Returns:

Expression

Overrides: QueryableAggregateDescription.CreateAggregateExpression(Expression, string)

CreateAggregateValueExpression(ParameterExpression)

Creates the aggregate expression.

protected override Expression CreateAggregateValueExpression(ParameterExpression itemExpression)

Parameters:itemExpressionParameterExpression

TODO: finish this.

Returns:

Expression

Overrides: QueryableAggregateDescription.CreateAggregateValueExpression(ParameterExpression)

GenerateFunctionName()

Generates identification string for this function using AggregateMethodName.

protected override string GenerateFunctionName()

Returns:

string

Function identification string.

Overrides: QueryableAggregateDescription.GenerateFunctionName()

GetDisplayName()

Gets the display-friendly name.

protected override string GetDisplayName()

Returns:

string

A string name.

Overrides: DescriptionBase.GetDisplayName()

GetUniqueName()

Returns the member name for this description.

public override string GetUniqueName()

Returns:

string

Overrides: DescriptionBase.GetUniqueName()