ClassAggregateValue
Holds a value presentation of an aggregate function accumulated during pivot grouping.
Definition
Namespace:Telerik.Pivot.Core.Aggregates
Assembly:Telerik.Pivot.Core.dll
Syntax:
public abstract class AggregateValue : CloneableInheritance: objectCloneableAggregateValue
Derived Classes:
Inherited Members
Constructors
AggregateValue()
Declaration
protected AggregateValue()Fields
ErrorAggregateValue
Gets an AggregateValue representing error.
Declaration
[SuppressMessage("Microsoft.Security", "CA2104:DoNotDeclareReadOnlyMutableReferenceTypes", Justification = "Error is immutable.")]
public static readonly AggregateValue ErrorAggregateValueField Value
Methods
AccumulateOverride(object)
Add the value to the results in the current AggregateValue instance.
Declaration
protected abstract void AccumulateOverride(object value)Parameters
value
The value to accumulate.
CloneCore(Cloneable)
Makes the instance a clone (deep copy) of the specified Cloneable.
Declaration
protected override void CloneCore(Cloneable source)Parameters
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).
GetValue()
Gets a presentation friendly value of the results in the current AggregateValue.
Declaration
[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Design choice.")]
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Design choice.")]
public object GetValue()Returns
Returns an object containing a formatted value or error object.
GetValueOverride()
Gets a presentation friendly value of the results in the current AggregateValue instance to be returned in GetValue(). If an error occurred during calculations the GetValue() will not call GetValueOverride() but return the error instead.
Declaration
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Design choice.")]
protected abstract object GetValueOverride()Returns
A result object.
MergeOverride(AggregateValue)
Merge the results of an AggregateValue with the results in the current AggregateValue instance.
Declaration
protected abstract void MergeOverride(AggregateValue childAggregate)Parameters
childAggregate
The AggregateValue to merge.