FieldFilterValues.FilterType Property

Gets or sets the field’s filter type.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v19.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.

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.

Note

A complete sample project is available at 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)

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/DXPivotGrid_CustomFilterPopup/CustomFilterEdit.cs#L53

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/DXPivotGrid_CustomFilterPopup/CustomFilterEdit.vb#L63

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