Back to all docs
API Reference / Telerik.Pivot.Core / PropertyAggregateDescriptionBase

Class
PropertyAggregateDescriptionBase

Base class that describes the aggregation of items using a property name as the criteria.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

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

Inheritance: objectCloneableSettingsNodeDescriptionBaseAggregateDescriptionBaseLocalAggregateDescriptionPropertyAggregateDescriptionBase

Derived Classes: PropertyAggregateDescription

Implements: IAggregateDescriptionIDescriptionBaseIEditableINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members LocalAggregateDescription.StringFormatLocalAggregateDescription.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

PropertyAggregateDescriptionBase()

Declaration

cs-api-definition
protected PropertyAggregateDescriptionBase()

Properties

AggregateFunction

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

Declaration

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

Property Value

AggregateFunction

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 AggregateFunctions of this PropertyAggregateDescriptionBase 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 PropertyAggregateDescriptionBase.

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 sealed void CloneCore(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Overrides LocalAggregateDescription.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).

CloneOverride(Cloneable)

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

Declaration

cs-api-definition
protected abstract void CloneOverride(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Remarks

Notes to Inheritors If you derive from Cloneable, you 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).

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

GetValueForItem(object)

Returns the value that will be passed in the aggregate for given item.

Declaration

cs-api-definition
protected override object GetValueForItem(object item)

Parameters

item

object

The item which value will be extracted.

Returns

object

Returns the value for given item.

Overrides LocalAggregateDescription.GetValueForItem(object)

In this article
DefinitionConstructorsPropertyAggregateDescriptionBase()PropertiesAggregateFunctionDataTypeIgnoreNullValuesPropertyNameSupportedAggregateFunctionsMethodsCloneCore(Cloneable)CloneOverride(Cloneable)GetDisplayName()GetUniqueName()GetValueForItem(object)
Not finding the help you need?
Contact Support