Class GrandTotalComparer

Used for IGroup comparison based on their grand totals.

Inheritance
System.Object
Cloneable
SettingsNode
GroupComparer
GrandTotalComparer
Inherited Members
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll

Syntax

public sealed class GrandTotalComparer : GroupComparer, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IEditable, IDescriptionsReferencing

Constructors

GrandTotalComparer()

Declaration
public GrandTotalComparer()

Properties

AggregateIndex

Gets or sets a value that indicates the aggregate's grand total to be used in the comparison.

Declaration
public int AggregateIndex { get; set; }
Property Value
System.Int32

Methods

CloneCore(Cloneable)

Makes the instance a clone (deep copy) of the specified Cloneable.

Declaration
protected override 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).

CompareGroups(IAggregateResultProvider, IGroup, IGroup, PivotAxis)

Compares two IGroups based on their grand totals.

Declaration
public override int CompareGroups(IAggregateResultProvider results, IGroup left, IGroup right, PivotAxis axis)
Parameters
IAggregateResultProvider results

The current aggregate results.
IGroup left

The first IGroup to compare.
IGroup right

The second IGroup to compare.
PivotAxis axis

Identifies if the groups are in Rows or Columns.
Returns
System.Int32

A signed integer that indicates the relative values of x and y, as shown in the following table.

Value Meaning Less than zero x is less than y.

Zero x equals y.

Greater than zero x is greater than y.
Overrides

CreateInstanceCore()

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

Declaration
protected override Cloneable CreateInstanceCore()
Returns
Cloneable

New instance for cloning.
Overrides
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.

Extension Methods