Class
CalculatedAggregateDescription

Class that describes the aggregation of items using CalculatedField as the criteria.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
public sealed class CalculatedAggregateDescription : LocalAggregateDescription, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed

Inheritance: objectCloneableSettingsNodeDescriptionBaseAggregateDescriptionBaseLocalAggregateDescriptionCalculatedAggregateDescription

Implements: IAggregateDescriptionIDescriptionBaseIEditableINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members LocalAggregateDescription.StringFormatLocalAggregateDescription.StringFormatSelectorAggregateDescriptionBase.TotalFormatAggregateDescriptionBase.DisplayValueAsKpiDescriptionBase.DisplayNameDescriptionBase.CustomNameSettingsNode.BeginEdit()SettingsNode.BeginInit()SettingsNode.EndInit()SettingsNode.GetService(Type)SettingsNode.ParentSettingsNode.SettingsChangedSettingsNode.ServicesChangedSettingsNode.PropertyChangedCloneable.Clone()

Constructors

CalculatedAggregateDescription()

Declaration

cs-api-definition
public CalculatedAggregateDescription()

Properties

CalculatedField

Declaration

cs-api-definition
public CalculatedField CalculatedField { get; }

Property Value

CalculatedField

Remarks

This property is initialized once ItemsSource is set.

CalculatedFieldName

Gets or sets the Name of the calculated field used in this CalculatedAggregateDescription.

Declaration

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

Property Value

string

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

CreateInstanceCore()

When implemented in a derived class, creates a new instance of the Cloneable derived class.

Declaration

cs-api-definition
protected override Cloneable CreateInstanceCore()

Returns

Cloneable

New instance for cloning.

Overrides Cloneable.CreateInstanceCore()

Remarks

Do not call this method directly (except when calling base in an implementation). This method is called internally by the Clone() method whenever a new instance of the Cloneable is created. Notes to Inheritors. Every Cloneable derived class must implement this method. A typical implementation is to simply call the default constructor and return the result.

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)