Class PropertyAggregateDescriptionBase
Base class that describes the aggregation of items using a property name as the criteria.
Inheritance
Inherited Members
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll
Syntax
public abstract class PropertyAggregateDescriptionBase : LocalAggregateDescription, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IEditable, IAggregateDescription, IDescriptionBase, INamed, ITotalFormatHost, IDescriptionsReferencing, IStringFormattableAggregate, IAggregateFunctionHost, IInitializeDescription, IDataFieldDescription
Constructors
PropertyAggregateDescriptionBase()
Declaration
protected PropertyAggregateDescriptionBase()
Properties
AggregateFunction
Gets or sets the aggregate function that will be used for summary calculation.
Declaration
public AggregateFunction AggregateFunction { get; set; }
Property Value
AggregateFunction
|
DataType
Provides the data type of the aggregate description.
Declaration
protected Type DataType { get; }
Property Value
System.Type
|
IgnoreNullValues
Gets or sets a value that determines whether the AggregateFunctions of this PropertyAggregateDescriptionBase will ignore null values when calculating the result.
Declaration
public bool IgnoreNullValues { get; set; }
Property Value
System.Boolean
|
PropertyName
Gets or sets a value identifying a property on the grouped items.
Declaration
public string PropertyName { get; set; }
Property Value
System.String
|
SupportedAggregateFunctions
Gets a list of suitable functions for the PropertyAggregateDescriptionBase.
Declaration
protected virtual IEnumerable<object> SupportedAggregateFunctions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.Object>
|
Methods
CloneCore(Cloneable)
Makes the instance a clone (deep copy) of the specified Cloneable.
Declaration
protected override sealed void CloneCore(Cloneable source)
Parameters
Cloneable
source
The object to clone. |
Overrides
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
protected abstract void CloneOverride(Cloneable source)
Parameters
Cloneable
source
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
protected override string GetDisplayName()
Returns
System.String
A System.String name. |
Overrides
GetUniqueName()
Returns the member name for this description.
Declaration
public override string GetUniqueName()
Returns
System.String
|
Overrides
GetValueForItem(Object)
Returns the value that will be passed in the aggregate for given item.
Declaration
protected override object GetValueForItem(object item)
Parameters
System.Object
item
The item which value will be extracted. |
Returns
System.Object
Returns the value for given item. |