Class ValueGroupFilter

A SingleGroupFilter that filter IGroups based on their AggregateValue subtotals.

Inheritance
System.Object
Cloneable
SettingsNode
GroupFilter
SingleGroupFilter
ValueGroupFilter
Inherited Members
Namespace: Telerik.Pivot.Core.Filtering
Assembly: Telerik.Pivot.Core.dll

Syntax

public sealed class ValueGroupFilter : SingleGroupFilter, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IEditable, IDescriptionsReferencing, IValueGroupFilter, IConditionFactory

Constructors

ValueGroupFilter()

Declaration
public ValueGroupFilter()

Properties

AggregateIndex

Gets or sets the aggregate index to be used in the filtering.

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

Condition

Gets or sets the Condition used to filter the groups.

Declaration
public LocalCondition Condition { get; set; }
Property Value
LocalCondition

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

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.

Filter(IGroup, IAggregateResultProvider, PivotAxis)

Identifies if a group should be filtered or not.

Declaration
protected override bool Filter(IGroup group, IAggregateResultProvider results, PivotAxis axis)
Parameters
IGroup group

The group.
IAggregateResultProvider results

Results for the current grouping. Could be used for totals lookup.
PivotAxis axis

Identifies if the group is positioned in the Rows or Columns.
Returns
System.Boolean

True if the group should be preserved, False if the group should be removed.
Overrides

Extension Methods