Class
OlapAggregateDescription

Used to specify aggregation parameters for OLAP data sources.

Definition

Namespace:Telerik.Pivot.Core.Olap

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
public class OlapAggregateDescription : AggregateDescriptionBase, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed

Inheritance: objectCloneableSettingsNodeDescriptionBaseAggregateDescriptionBaseOlapAggregateDescription

Derived Classes: AdomdAggregateDescriptionXmlaAggregateDescription

Implements: IAggregateDescriptionIDescriptionBaseIEditableINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members AggregateDescriptionBase.TotalFormatDescriptionBase.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()

Properties

DataType

Provides the data type of the aggregate description.

Declaration

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

Property Value

Type

DisplayValueAsKpi

Gets a value indicating whether aggregate values should be interpreted as KPIs.

Declaration

cs-api-definition
public override bool DisplayValueAsKpi { get; }

Property Value

bool

true if values will be interpreted as KPIs; otherwise, false.

Overrides AggregateDescriptionBase.DisplayValueAsKpi

MemberName

Gets or sets cube measure name that is used for aggregation.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods", Justification = "Design choice.")]
[DataMember]
public string MemberName { get; set; }

Property Value

string

The name of the field.

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

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