PivotGridFieldFilterValues.FilterType Property

Gets or sets the field’s filter type.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v23.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

Property Value

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

Available values:

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

Remarks

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

If the FilterType property is set to the PivotFilterType.Included value, only the records that contain values from the PivotGridFieldFilterValues.Values array in the corresponding field are displayed by a pivot grid. Otherwise, if the FilterType property is set to the PivotFilterType.Excluded value, only the records that do not contain values from the PivotGridFieldFilterValues.Values array in the corresponding field are displayed.

Note that when you change the filter type via the FilterType property, the actual filter condition is inverted. To switch the filter type without changing the filter condition, use the PivotGridFieldFilterValues.InvertFilterType or PivotGridFieldFilterValues.SetFilterType method. These methods invert the PivotGridFieldFilterValues.Values array after changing the filter type (i.e., they clear and populate the array with field values that were not contained in it previously).

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#

aspxpivotgrid-field-calculation-bindings/CS/AspNetWebFormsPivotFieldCalculationBindings/Default.aspx.cs#L23

fieldCountry.FilterValues.Add("UK");
fieldProductName.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included;
fieldCountry.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included;

winforms-pivot-grid-show-custom-display-text/CS/WinFormsPivotCustomCellDisplayText/Form1.cs#L10

salesPersonTableAdapter1.Fill(nwindDataSet1.SalesPerson);
fieldCountry.FilterValues.FilterType = PivotFilterType.Included;
fieldCountry.FilterValues.Add("UK");

winforms-dashboard-add-custom-interactivity-to-dashboard/CS/Dashboard_CustomVisualInteractivity/Form1.cs#L39

pivotGridControl1.BeginUpdate();
fieldCategoryName1.FilterValues.FilterType = PivotFilterType.Included;
fieldCategoryName1.FilterValues.Clear();

aspxpivotgrid-layout-upgrade-event/CS/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.cs#L20

fieldProductName.FilterValues.Add("Gula Malacca");
fieldProductName.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included;

winforms-pivot-grid-sort-data-by-olap-member-properties/CS/WinFormsPivotGridCustomOLAPSort/Form1.cs#L17

fieldProduct.SortMode = PivotSortMode.Custom;
fieldFiscalYear.FilterValues.FilterType = PivotFilterType.Included;
fieldFiscalYear.FilterValues.ValuesIncluded = new object[] { 2004, 2005 };

VB.NET

aspxpivotgrid-field-calculation-bindings/VB/AspNetWebFormsPivotFieldCalculationBindings/Default.aspx.vb#L25

fieldCountry.FilterValues.Add("UK")
fieldProductName.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included
fieldCountry.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included

winforms-pivot-grid-show-custom-display-text/VB/VBWinFormsPivotCustomCellDisplayText/Form1.vb#L9

SalesPersonTableAdapter1.Fill(NwindDataSet1.SalesPerson)
fieldCountry.FilterValues.FilterType = PivotFilterType.Included
fieldCountry.FilterValues.Add("UK")

winforms-dashboard-add-custom-interactivity-to-dashboard/VB/Dashboard_CustomVisualInteractivity/Form1.vb#L38

pivotGridControl1.BeginUpdate()
fieldCategoryName1.FilterValues.FilterType = PivotFilterType.Included
fieldCategoryName1.FilterValues.Clear()

aspxpivotgrid-layout-upgrade-event/VB/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.vb#L21

fieldProductName.FilterValues.Add("Gula Malacca")
fieldProductName.FilterValues.FilterType = DevExpress.XtraPivotGrid.PivotFilterType.Included

winforms-pivot-grid-sort-data-by-olap-member-properties/VB/WinFormsPivotGridCustomOLAPSort/Form1.vb#L17

fieldProduct.SortMode = PivotSortMode.Custom
fieldFiscalYear.FilterValues.FilterType = PivotFilterType.Included
fieldFiscalYear.FilterValues.ValuesIncluded = New Object() {2004, 2005}