FieldFilterValues.FilterType Property

Gets or sets the field’s filter type.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v18.2.dll

Declaration

C#

[DefaultValue(FieldFilterType.Excluded)]
public FieldFilterType FilterType { get; set; }

VB.NET

<DefaultValue(FieldFilterType.Excluded)>
Public Property FilterType As FieldFilterType

Property Value

Type	Default	Description
FieldFilterType	**Excluded**	A FieldFilterType enumeration value which specifies the field’s filter type.

Available values:

Name	Description
Excluded	Specifies that the DXPivotGrid control should not display the filter values. All the other values will be displayed.
Included	Specifies that the DXPivotGrid control should display only the filter values.

Remarks

The FilterType property specifies whether only the records that contain values from the PivotGridFieldFilterValues.Values array of a specific field are displayed in a pivot grid.

If the FilterType property is set to the FieldFilterType.Included value, only the records which contain values from the PivotGridFieldFilterValues.Values array of a specific field are displayed by a pivot grid. Otherwise, if the FilterType property is set to the FieldFilterType.Excluded value, only the records which don’t contain values from the PivotGridFieldFilterValues.Values array of a specific field are displayed.

Example

This example shows how to apply a filter to a field. For this, a new FilterFieldValues method was created.

The first condition will select records which contain ‘UK’ in the ‘fieldCountry’ field. The second condition will filter the ‘Category’ field to display only four categories: ‘Beverages’, ‘Condiments’, ‘Seafood’, and ‘Produce’.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-apply-filter-to-a-field-e2134.

MainWindow.xaml.vb

Imports System.Windows
Imports System
Imports DevExpress.Xpf.PivotGrid
Imports System.Collections.Generic

Namespace WpfPivotGridFilterValues
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()

            ' Filters values in the Country field using the created method.
            FilterFieldValues(fieldCountry,
                  New String() {"UK"}, FieldFilterType.Included)

            ' Filters values in the Category field using the created method.
            FilterFieldValues(fieldCategory,
                  New String() {"Beverages", "Condiments", "Seafood", "Produce"}, FieldFilterType.Included)
        End Sub

        ' Creates a new method that allows filtering field values.
        Private Function FilterFieldValues(ByVal field As PivotGridField,
                                           ByVal filterValues() As Object,
                                           ByVal filterType As FieldFilterType) As Object()
            ' Locks the control to prevent its excessive updates when multiple properties are modified.
            pivotGridControl1.BeginUpdate()
            Try
                ' Clears the filter value collection and adds object items to it.
                field.FilterValues.Clear()
                For Each filterValue As Object In filterValues
                    field.FilterValues.Add(filterValue)
                Next filterValue
            Finally
                ' Specifies that the control should only display records 
                ' which contain the specified values in the field.
                field.FilterValues.FilterType = filterType

                ' Unlocks the control.
                pivotGridControl1.EndUpdate()
            End Try
            Return filterValues
        End Function
    End Class
End Namespace

MainWindow.xaml

<Window x:Class="WpfPivotGridFilterValues.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        dx:ThemeManager.Theme="Office2013LightGray" 
        Title="Pivot Grid Filtering" 
        Height="260" Width="620" 
        xmlns:my="clr-namespace:WpfPivotGridFilterValues.nwindDataSetTableAdapters" 
        xmlns:my1="clr-namespace:WpfPivotGridFilterValues">
    <Window.Resources>
        <dx:TypedSimpleSource x:Key="TypedSimpleSource" AdapterType="my:SalesPersonTableAdapter" 
                              ContextType="my1:nwindDataSet" Path="SalesPerson">
            <dx:DesignDataManager.DesignData>
                <dx:DesignDataSettings RowCount="5" />
            </dx:DesignDataManager.DesignData>
        </dx:TypedSimpleSource>
    </Window.Resources>
    <Grid>
        <dxpg:PivotGridControl Name="pivotGridControl1" 
                               DataSource="{Binding Path=Data, Source={StaticResource TypedSimpleSource}}">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Area="RowArea" Caption="Category" FieldName="CategoryName" 
                                     Name="fieldCategory" AreaIndex="0" />
                <dxpg:PivotGridField Area="ColumnArea" FieldName="Country" 
                                     Name="fieldCountry" AreaIndex="1" />
                <dxpg:PivotGridField Area="DataArea" FieldName="Extended Price" 
                                     Name="fieldExtendedPrice" AreaIndex="0" />
                <dxpg:PivotGridField Area="ColumnArea" Caption="Sales Person" 
                                     Name="pivotGridField2" FieldName="Sales Person" AreaIndex="2" />
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Windows;
using System;
using DevExpress.Xpf.PivotGrid;
using System.Collections.Generic;

namespace WpfPivotGridFilterValues
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            // Filters values in the Country field using the created method.
            FilterFieldValues(fieldCountry, new string[] { "UK" }, FieldFilterType.Included);

            // Filters values in the Category field using the created method.
            FilterFieldValues(fieldCategory, new string[] { "Beverages", "Condiments", "Seafood", "Produce" }, 
                FieldFilterType.Included);
        }

        // Creates a new method that allows filtering field values.
        private object[] FilterFieldValues(PivotGridField field, object[] filterValues, 
            FieldFilterType filterType)
        {
            // Locks the control to prevent its excessive updates when multiple properties are modified.
            pivotGridControl1.BeginUpdate();
            try
            {
                // Clears the filter value collection and adds object items to it.
                field.FilterValues.Clear();
                foreach (object filterValue in filterValues)
                    field.FilterValues.Add(filterValue);
            }
            finally
            {
                // Specifies that the control should only display records 
                // which contain the specified values in the field.
                field.FilterValues.FilterType = filterType;

                // Unlocks the control.
                pivotGridControl1.EndUpdate();
            }
            return filterValues;
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterType property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-prevent-end-users-from-changing-the-filter-condition-e2401/CS/DXPivotGrid_CancelFilterChanging/MainWindow.xaml.cs#L17

if (Equals(e.Field, fieldCategoryName)) {
    if ((e.Field.FilterValues.FilterType == FieldFilterType.Excluded &&
            e.Values.Contains("Beverages")) ||

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264201/CS/WPFPivotGridCustomServerModeSort/MainWindow.xaml.cs#L21

    field.FilterValues.Add(1998);
    field.FilterValues.FilterType = FieldFilterType.Included;
}

how-to-apply-filter-to-a-field-e2134/CS/WpfPivotGridFilterValues/MainWindow.xaml.cs#L42

// which contain the specified values in the field.
field.FilterValues.FilterType = filterType;

wpf-pivot-grid-apply-format-conditions-to-data-cells/CS/WpfPivotGridConditionalFormatting/MainWindow.xaml.cs#L54

{
    field.FilterValues.FilterType = filterType;
    pivotGridControl1.EndUpdate();

how-to-define-a-custom-filter-popup-with-custom-toolbar-buttons-and-a-filter-editor-t357159/CS/CustomFilterPopup/CustomFilterPopup.cs#L83

var values = SelectedItems.OfType<PivotValueInfo>().Select(v => v.Value).ToArray();
if (PivotField.FilterValues.FilterType == FieldFilterType.Included)
    PivotField.FilterValues.ValuesIncluded = values;

VB.NET

how-to-prevent-end-users-from-changing-the-filter-condition-e2401/VB/DXPivotGrid_CancelFilterChanging/MainWindow.xaml.vb#L19

If Equals(e.Field, fieldCategoryName) Then
    If (e.Field.FilterValues.FilterType = FieldFilterType.Excluded AndAlso _
                e.Values.Contains("Beverages")) OrElse _

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264201/VB/WPFPivotGridCustomServerModeSort/MainWindow.xaml.vb#L19

    field.FilterValues.Add(1998)
    field.FilterValues.FilterType = FieldFilterType.Included
Finally

how-to-apply-filter-to-a-field-e2134/VB/WpfPivotGridFilterValues/MainWindow.xaml.vb#L40

' which contain the specified values in the field.
field.FilterValues.FilterType = filterType

wpf-pivot-grid-apply-format-conditions-to-data-cells/VB/WpfPivotGridConditionalFormatting/MainWindow.xaml.vb#L51

Finally
    field.FilterValues.FilterType = filterType
    pivotGridControl1.EndUpdate()

how-to-define-a-custom-filter-popup-with-custom-toolbar-buttons-and-a-filter-editor-t357159/VB/CustomFilterPopup/CustomFilterPopup.vb#L94

Dim values = SelectedItems.OfType(Of PivotValueInfo)().Select(Function(v) v.Value).ToArray()
If PivotField.FilterValues.FilterType = FieldFilterType.Included Then
    PivotField.FilterValues.ValuesIncluded = values