[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.FilteringUI
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Collapse]DevExpress.Xpf.PivotGrid
    AllowHideFieldsType Enumeration
    AsyncCompletedHandler Delegate
   [Expand]AsyncOperationResult Class
   [Expand]CellElement Class
   [Expand]CellElementData Class
   [Expand]CellInfo Class
   [Expand]ColorScaleFormatCondition Class
    CopyCollapsedValuesMode Enumeration
    CopyMultiSelectionMode Enumeration
   [Expand]CustomPrefilterDisplayTextEventArgs Class
    CustomPrefilterDisplayTextEventHandler Delegate
   [Expand]CustomServerModeSortEventArgs Class
   [Expand]DataAreaElement Class
   [Expand]DataAreaElementData Class
   [Expand]DataBarFormatCondition Class
    DataFieldArea Enumeration
    DataHeadersDisplayMode Enumeration
    DataProcessingEngine Enumeration
   [Expand]DefaultMenuItemNames Class
   [Expand]EventArgsToCellInfoConverter Class
   [Expand]EventArgsToFieldValueInfoConverter Class
   [Expand]ExpressionConditionBase Class
    FieldAllowedAreas Enumeration
    FieldArea Enumeration
    FieldBestFitArea Enumeration
    FieldColumnTotalsLocation Enumeration
    FieldFilterType Enumeration
   [Collapse]FieldFilterValues Class
     FieldFilterValues Members
     FieldFilterValues Constructor
    [Expand]FieldFilterValues Properties
    [Expand]FieldFilterValues Methods
    FieldGroupInterval Enumeration
    FieldListAllowedLayouts Enumeration
    FieldListArea Enumeration
   [Expand]FieldListControlBase Class
    FieldListLayout Enumeration
    FieldListOrientation Enumeration
    FieldListStyle Enumeration
    FieldOLAPFilterUsingWhereClause Enumeration
    FieldPropertyName Enumeration
    FieldRowTotalsLocation Enumeration
    FieldSortBySummaryOrder Enumeration
    FieldSortLocation Enumeration
    FieldSortMode Enumeration
    FieldSortOrder Enumeration
    FieldSummaryDisplayType Enumeration
    FieldSummaryType Enumeration
    FieldTopValueMode Enumeration
    FieldTopValueType Enumeration
    FieldTotalsVisibility Enumeration
    FieldUnboundColumnType Enumeration
    FieldUnboundExpressionMode Enumeration
   [Expand]FieldValueCell Class
   [Expand]FieldValueElement Class
   [Expand]FieldValueElementData Class
   [Expand]FieldValueInfo Class
    FieldValueType Enumeration
    FilterPopupMode Enumeration
   [Expand]FormatCondition Class
   [Expand]FormatConditionBase Class
   [Expand]FormatConditionCollection Class
   [Expand]FormatConditionCommandParameters Class
   [Expand]GroupChangedEventArgs Class
    GroupChangedEventHandler Delegate
    GroupChangeType Enumeration
    GroupFilterMode Enumeration
   [Expand]GroupFilterValue Class
   [Expand]GroupFilterValues Class
   [Expand]GroupFilterValuesCollection Class
   [Expand]IconSetFormatCondition Class
   [Expand]IndicatorFormatConditionBase Class
   [Expand]IThreadSafeField Interface
   [Expand]LightweightCellElement Class
   [Expand]LightweightFieldValueElement Class
    OlapDataProvider Enumeration
   [Expand]PivotBrushChangedEventArgs Class
    PivotBrushChangedEventHandler Delegate
    PivotBrushType Enumeration
   [Expand]PivotCellBaseEventArgs Class
   [Expand]PivotCellDisplayTextEventArgs Class
    PivotCellDisplayTextEventHandler Delegate
   [Expand]PivotCellEventArgs Class
    PivotCellEventHandler Delegate
   [Expand]PivotCellValueEventArgs Class
    PivotCellValueEventHandler Delegate
    PivotChartDataProvideMode Enumeration
    PivotChartDataProvidePriority Enumeration
   [Expand]PivotChartDataSourceRow Class
    PivotChartExportFieldValueMode Enumeration
    PivotChartFieldValuesProvideMode Enumeration
    PivotChartItemDataMember Enumeration
    PivotChartItemType Enumeration
   [Expand]PivotCustomCellAppearanceEventArgs Class
    PivotCustomCellAppearanceEventHandler Delegate
   [Expand]PivotCustomChartDataSourceDataEventArgs Class
    PivotCustomChartDataSourceDataEventHandler Delegate
   [Expand]PivotCustomChartDataSourceRowsEventArgs Class
    PivotCustomChartDataSourceRowsEventHandler Delegate
   [Expand]PivotCustomFieldDataEventArgs Class
    PivotCustomFieldDataEventHandler Delegate
   [Expand]PivotCustomFieldListSortEventArgs Class
   [Expand]PivotCustomFieldSortEventArgs Class
    PivotCustomFieldSortEventHandler Delegate
   [Expand]PivotCustomFieldValueCellsEventArgs Class
    PivotCustomFieldValueCellsEventHandler Delegate
   [Expand]PivotCustomFilterPopupItemsEventArgs Class
    PivotCustomFilterPopupItemsEventHandler Delegate
   [Expand]PivotCustomGroupIntervalEventArgs Class
    PivotCustomGroupIntervalEventHandler Delegate
   [Expand]PivotCustomSummaryEventArgs Class
    PivotCustomSummaryEventHandler Delegate
   [Expand]PivotCustomValueAppearanceEventArgs Class
    PivotCustomValueAppearanceEventHandler Delegate
    PivotDefaultMemberFields Enumeration
   [Expand]PivotDrillDownDataRow Class
   [Expand]PivotDrillDownDataSource Class
   [Expand]PivotExcelFieldListControl Class
   [Expand]PivotFieldAreaChangingEventArgs Class
    PivotFieldAreaChangingEventHandler Delegate
   [Expand]PivotFieldDisplayTextEventArgs Class
    PivotFieldDisplayTextEventHandler Delegate
   [Expand]PivotFieldEventArgs Class
    PivotFieldEventHandler Delegate
   [Expand]PivotFieldFilterChangingEventArgs Class
    PivotFieldFilterChangingEventHandler Delegate
   [Expand]PivotFieldListControl Class
   [Expand]PivotFieldPropertyChangedEventArgs Class
    PivotFieldPropertyChangedEventHandler Delegate
   [Expand]PivotFieldValueCancelEventArgs Class
    PivotFieldValueCancelEventHandler Delegate
   [Expand]PivotFieldValueEventArgs Class
    PivotFieldValueEventHandler Delegate
   [Expand]PivotFilterEditorEventArgs Class
    PivotFilterEditorEventHandler Delegate
   [Expand]PivotGridCellMenuInfo Class
   [Expand]PivotGridCommands Class
   [Expand]PivotGridControl Class
   [Expand]PivotGridCsvExportOptions Class
   [Expand]PivotGridCustomTotal Class
   [Expand]PivotGridCustomTotalCollection Class
   [Expand]PivotGridField Class
   [Expand]PivotGridFieldCollection Class
   [Expand]PivotGridFieldValueMenuInfo Class
   [Expand]PivotGridFilterPopupMenuInfo Class
   [Expand]PivotGridGroup Class
   [Expand]PivotGridGroupCollection Class
   [Expand]PivotGridHeaderMenuInfo Class
   [Expand]PivotGridHeadersAreaMenuInfo Class
   [Expand]PivotGridMenuInfo Class
    PivotGridMenuType Enumeration
   [Expand]PivotGridPopupMenu Class
   [Expand]PivotGridXlsExportOptions Class
   [Expand]PivotGridXlsxExportOptions Class
   [Expand]PivotGroupEventArgs Class
    PivotGroupEventHandler Delegate
    PivotKpiGraphic Enumeration
    PivotKpiType Enumeration
   [Expand]PivotLayoutAllowEventArgs Class
    PivotLayoutAllowEventHandler Delegate
   [Expand]PivotLayoutUpgradeEventArgs Class
    PivotLayoutUpgradeEventHandler Delegate
   [Expand]PivotOlapExceptionEventArgs Class
    PivotOlapExceptionEventHandler Delegate
   [Expand]PivotOlapKpiMeasures Class
   [Expand]PivotOlapKpiValue Class
   [Expand]PivotOlapMember Class
   [Expand]PivotPropertyChangedEventArgs Class
    PivotPropertyChangedEventHandler Delegate
   [Expand]PivotQueryExceptionEventArgs Class
    PivotQueryExceptionEventHandler Delegate
   [Expand]PivotSerializationOptions Class
   [Expand]PivotSummaryDataRow Class
   [Expand]PivotSummaryDataSource Class
   [Expand]PivotUnboundExpressionEditorEventArgs Class
    PivotUnboundExpressionEditorEventHandler Delegate
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
    ScrollingMode Enumeration
    SelectMode Enumeration
    ShowPrefilterPanelMode Enumeration
   [Expand]SortByCondition Class
   [Expand]SortByConditionCollection Class
    StoreLayoutMode Enumeration
   [Expand]TopBottomRuleFormatCondition Class
    UnboundExpressionMode Enumeration
    UseLightweightTemplates Enumeration
    UserAction Enumeration
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

FieldFilterValues Class

Contains filter values for a specific field.

Namespace:DevExpress.Xpf.PivotGrid
Assembly:DevExpress.Xpf.PivotGrid.v19.1.dll

Expanded Syntax

Expanded Remarks

A field's PivotGridField.FilterValues property of the FieldFilterValues class gives the ability to apply a filter to a field, i.e. select which of the records should be processed by the PivotGrid control. A filter specified by the PivotGridField.FilterValues property is in effect for filter fields, column fields and row fields.

The FieldFilterValues class stores filter values for a specific field. The filtering functionality is dependant upon the FilterType property's value. It specifies whether the filter values should be displayed in or removed from the PivotGrid control.

If the FilterType property is set to FieldFilterType.Included, the FieldFilterValues class stores the values which should be displayed within the control. In this instance, the PivotGrid control will only process those records that contain filter values in the corresponding field.

If the FilterType property is set to FieldFilterType.Excluded, the FieldFilterValues class stores the values which will not be displayed within the control. In this instance, the PivotGrid control will only process those records that do not contain filter values in the corresponding field.

To add values to and remove them from the filter value list use the DevExpress.XtraPivotGrid.PivotGridFieldFilterValues.Add and DevExpress.XtraPivotGrid.PivotGridFieldFilterValues.Remove methods.

Specific fields can contain Null (or DBNull) values. The DevExpress.XtraPivotGrid.PivotGridFieldFilterValues.ShowBlanks property determines whether the records which contain Null values should be processed by the control. If this property is set to false summaries are not calculated against such records.

An end-user can apply a filter to a field via the filter dropdown. It can be activated by clicking the field's Filter Button. When an end-user checks/unchecks items within the filter dropdown this automatically modifies the filter value collection.

Expanded 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.

Expanded Inheritance Hierarchy

System.Object
    PivotGridFieldFilterValues
       FieldFilterValues

Expanded See Also

Is this topic helpful?​​​​​​​