PivotFilter Class

A filter applied to data displayed in the PivotGridControl.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public class PivotFilter :
    PivotFilterBase,
    IFilterFormOwner,
    IUIFilterSource,
    IXtraSerializable

VB.NET

Public Class PivotFilter
    Inherits PivotFilterBase
    Implements IFilterFormOwner,
               IUIFilterSource,
               IXtraSerializable

Related API Members

The following members return PivotFilter objects:

• PivotGridControl.ActiveFilter

Remarks

Use the PivotGridControl.ActiveFilter property to access filter settings of the PivotGridControl.

To learn more about filtering, see Filtering Overview.

Example

The example below shows how to apply complex filter criteria in code using the PivotFilter.Criteria property. This property is exposed by the PivotFilter object that can be accessed using PivotGridControl.ActiveFilter.

C#

using DevExpress.Data.Filtering;
// ...
            pivotGridControl.ActiveFilter.Criteria = new GroupOperator(GroupOperatorType.And,
                new InOperator(fieldTrademark.PrefilterColumnName, new string[] { "Chevrolet", "Chrysler", "Dodge", "Ford" }),
                new InOperator(fieldBodyStyle.PrefilterColumnName, new string[] { "Coupe" }));

VB.NET

Imports DevExpress.Data.Filtering
' ...
            pivotGridControl.ActiveFilter.Criteria = New GroupOperator(GroupOperatorType.And,
                New InOperator(fieldTrademark.PrefilterColumnName, New String() {"Chevrolet", "Chrysler", "Dodge", "Ford"}),
                New InOperator(fieldBodyStyle.PrefilterColumnName, New String() {"Coupe"}))

Inheritance

Object

DevExpress.Utils.Controls.DisposableObject

BaseFilter

PivotFilterBase

PivotFilter