New to Telerik UI for WPFStart a free 30-day trial

A SingleGroupFilter that filter IGroups based on their AggregateValue subtotals.

Definition

Namespace:Telerik.Pivot.Core.Filtering

Assembly:Telerik.Pivot.Core.dll

Syntax:

C#
[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

C#
public ValueGroupFilter()

Properties

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

C#
[DataMember]
public int AggregateIndex { get; set; }

Gets or sets the Condition used to filter the groups.

C#
[DataMember]
public LocalCondition Condition { get; set; }

Methods

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

C#
protected override void CloneCore(Cloneable source)
Parameters:sourceCloneable

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

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

C#
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.

Identifies if a group should be filtered or not.

C#
protected override bool Filter(IGroup group, IAggregateResultProvider results, PivotAxis axis)
Parameters:groupIGroup

The group.

resultsIAggregateResultProvider

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

axisPivotAxis

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)