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

Adds the specified filter values to the collection.

Namespace: DevExpress.Xpf.PivotGrid

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

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

The following example shows how to filter the Category field by the “Produce” and “Seafood” values. For this, add these values to the PivotGridField.FieldFilterValues collection.

C#

public MainWindow() {
    List<object> filterValues = new List<object>();
    filterValues.Add("Produce");
    filterValues.Add("Seafood");

    fieldCategory.SetFilterValues(filterValues.ToArray(), 
        DevExpress.Xpf.PivotGrid.FieldFilterType.Included, true);
}

VB.NET

Public Sub New()
    Dim filterValues As New List(Of Object)()
    filterValues.Add("Produce")
    filterValues.Add("Seafood")

    fieldCategory.SetFilterValues(filterValues.ToArray(), 
        DevExpress.Xpf.PivotGrid.FieldFilterType.Included, True)
End Sub

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.