PivotGridField.SetFilterValues(Object[], FieldFilterType, Boolean) Method

Adds the specified filter values to the collection.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public void SetFilterValues(
    object[] values,
    FieldFilterType filterType,
    bool showBlanks
)

VB.NET

Public Sub SetFilterValues(
    values As Object(),
    filterType As FieldFilterType,
    showBlanks As Boolean
)

Parameters

Name	Type	Description
values	Object[]	An object that represents a collection of field filter values.
filterType	FieldFilterType	A FieldFilterType enumeration member that specifies the filter type.
showBlanks	Boolean	True, to show blank values; otherwise, false.

Remarks

You can get or set the field filter values collection by using the PivotGridField.FieldFilterValues property.

To add filter values to the collection asynchronously, use the PivotGridField.SetFilterValuesAsync method.

Example

This example shows how to apply a filter to a field.

The first filter selects records which contain UK in the fieldCountry field, the second filter selects four categories in the fieldCategoryName field: Beverages, Condiments, Seafood, and Produce.

View Example: How to Apply a Filter to a Field

MainWindow.xaml.cs

    fieldCountry.SetFilterValues(new string[] { "UK" }, FieldFilterType.Included, true);
    fieldCategoryName.SetFilterValues(new string[] { "Beverages", "Condiments", "Seafood", "Produce" }, FieldFilterType.Included, true);

MainWindow.xaml.vb

    fieldCountry.SetFilterValues(New String() { "UK" }, FieldFilterType.Included, True)
    fieldCategoryName.SetFilterValues(New String() { "Beverages", "Condiments", "Seafood", "Produce" }, FieldFilterType.Included, True)