Class
LocalAggregateDescription

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 LocalAggregateDescription : AggregateDescriptionBase, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed

Inheritance: objectCloneableSettingsNodeDescriptionBaseAggregateDescriptionBaseLocalAggregateDescription

Derived Classes: CalculatedAggregateDescriptionPropertyAggregateDescriptionBase

Implements: IAggregateDescriptionIDescriptionBaseIEditableINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members AggregateDescriptionBase.TotalFormatAggregateDescriptionBase.DisplayValueAsKpiDescriptionBase.GetDisplayName()DescriptionBase.GetUniqueName()DescriptionBase.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()

Properties

StringFormat

Gets or sets a general string format to use for this AggregateDescriptionBase AggregateValue. This format will be used if the AggregateFunction or TotalFormat does not alter the meaning of the original data.

Declaration

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

Property Value

string

StringFormatSelector

Gets or sets a StringFormatSelector that would provide a proper StringFormat for AggregateFunction or TotalFormat that alter the meaning of the original data. StringFormat. TotalFormat.

Declaration

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

Property Value

StringFormatSelector

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

GetValueForItem(object)

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

Declaration

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

Parameters

item

object

The item which value will be extracted.

Returns

object

Returns the value for given item.