Class
ValueGroupFilter

A SingleGroupFilter that filter IGroups based on their AggregateValue subtotals.

Definition

Namespace:Telerik.Pivot.Core.Filtering

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
public sealed class ValueGroupFilter : SingleGroupFilter, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable

Inheritance: objectCloneableSettingsNodeGroupFilterSingleGroupFilterValueGroupFilter

Implements: IEditableINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members SettingsNode.BeginEdit()SettingsNode.BeginInit()SettingsNode.EndInit()SettingsNode.GetService(Type)SettingsNode.ParentSettingsNode.SettingsChangedSettingsNode.ServicesChangedSettingsNode.PropertyChangedCloneable.Clone()

Constructors

ValueGroupFilter()

Declaration

cs-api-definition
public ValueGroupFilter()

Properties

AggregateIndex

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

Declaration

cs-api-definition
[DataMember]
public int AggregateIndex { get; set; }

Property Value

int

Condition

Gets or sets the Condition used to filter the groups.

Declaration

cs-api-definition
[DataMember]
public LocalCondition Condition { get; set; }

Property Value

LocalCondition

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

Filter(IGroup, IAggregateResultProvider, PivotAxis)

Identifies if a group should be filtered or not.

Declaration

cs-api-definition
protected override bool Filter(IGroup group, IAggregateResultProvider results, PivotAxis axis)

Parameters

group

IGroup

The group.

results

IAggregateResultProvider

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

axis

PivotAxis

Identifies if the group is positioned in the Rows or Columns.

Returns

bool

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

Overrides SingleGroupFilter.Filter(IGroup, IAggregateResultProvider, PivotAxis)