PivotGridControl.ActiveFilter Property

Provides access to settings of the filter applied to the PivotGridControl‘s data.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

[DXCategory("Data")]
[XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue)]
[XtraSerializablePropertyId(2)]
public PivotFilter ActiveFilter { get; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue)>
<XtraSerializablePropertyId(2)>
<DXCategory("Data")>
Public ReadOnly Property ActiveFilter As PivotFilter

Property Value

Type	Description
PivotFilter	A PivotFilter object that is a filter applied to data displayed in the PivotGridControl.

Remarks

To learn more about filtering, see Filtering Overview.

Note

Filter Panel and Filter Editor display ActiveFilter if the following conditions are met:

• the data source type is not OLAP
• the field’s area is not DataArea (the PivotGridFieldBase.Area is not PivotArea.DataArea)
• no subscriptions for the PivotGridControl.CustomFilterPopupItems event
• the WindowsFormsSettings.ColumnFilterPopupMode static option is not set to the FieldFilterPopupMode.Classic value
• the PivotGridOptionsFilterPopup.FieldFilterPopupMode option is not set to the FieldFilterPopupMode.Classic value

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"}))