[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
   [Expand]FieldFilterValues Class
    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
   [Collapse]PivotGridControl Class
     PivotGridControl Members
     PivotGridControl Constructor
    [Expand]PivotGridControl Properties
    [Collapse]PivotGridControl Events
      AsyncOperationCompleted Event
      AsyncOperationStarting Event
      BeforeLoadLayout Event
      BeginRefresh Event
      BrushChanged Event
      CellClick Event
      CellDoubleClick Event
      CellSelectionChanged Event
      CustomCellAppearance Event
      CustomCellDisplayText Event
      CustomCellValue Event
      CustomChartDataSourceData Event
      CustomChartDataSourceRows Event
      CustomFieldListSort Event
      CustomFieldSort Event
      CustomFieldValueCells Event
      CustomFilterPopupItems Event
      CustomGroupInterval Event
      CustomPrefilterDisplayText Event
      CustomServerModeSort Event
      CustomSummary Event
      CustomUnboundFieldData Event
      CustomValueAppearance Event
      DataSourceChanged Event
      EndRefresh Event
      FieldAreaChanged Event
      FieldAreaChanging Event
      FieldAreaIndexChanged Event
      FieldExpandedInGroupChanged Event
      FieldFilterChanged Event
      FieldFilterChanging Event
      FieldPropertyChanged Event
      FieldSizeChanged Event
      FieldUnboundExpressionChanged Event
      FieldValueCollapsed Event
      FieldValueCollapsing Event
      FieldValueDisplayText Event
      FieldValueExpanded Event
      FieldValueExpanding Event
      FieldValueNotExpanded Event
      FieldVisibleChanged Event
      FieldVisibleChanging Event
      FocusedCellChanged Event
      GridLayout Event
      GroupFilterChanged Event
      HiddenFieldList Event
      LayoutUpgrade Event
      OlapDataLoaded Event
      OlapException Event
      OlapQueryData Event
      OlapQueryTimeout Event
      PopupMenuShowing Event
      PrefilterCriteriaChanged Event
      PrefilterEditorCreated Event
      PrefilterEditorHiding Event
      PropertyChanged Event
      QueryException Event
      ShownFieldList Event
      UnboundExpressionEditorCreated Event
    [Expand]PivotGridControl Methods
   [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]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)

PivotGridControl.FieldFilterChanging Event

Allows you to customize the filter that is being applied or cancel filtering.

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

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type PivotFieldFilterChangingEventArgs containing data related to this event.

The following PivotFieldFilterChangingEventArgs properties provide information specific to this event.
Property Description
Cancel Gets or sets whether to cancel changing the filter condition.
Field Gets the field being processed.
FilterType Gets the current filter type.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible System.Windows.RoutedEventArgs.Source adjustment by a parent class.
RoutedEvent Gets or sets the System.Windows.RoutedEventArgs.RoutedEvent associated with this System.Windows.RoutedEventArgs instance.
Source Gets or sets a reference to the object that raised the event.
Values Gets the collection of filter values, about to be assigned to the filter.

Expanded Remarks

The FieldFilterChanging event occurs before a field's filter condition is changed. To obtain the collection of filter values which is about to be assigned to the filter, use the event parameter's PivotFieldFilterChangingEventArgs.Values property. To cancel changing the current filter values collection, set the PivotFieldFilterChangingEventArgs.Cancel property to true. You can also obtain the field for which the filter condition is being changed, and the current filter type using the event parameter's PivotFieldEventArgs.Field and PivotFieldFilterChangingEventArgs.FilterType properties, respectively.

After the filter condition has been changed, the FieldFilterChanged event is fired.

Note

To remove default filter items and add custom items instead, use the CustomFilterPopupItems event.

Expanded Example

The following example shows how to prevent end-users from changing the filter condition.In this example, the FieldFilterChanging event is handled to prevent an end-user from hiding the 'Beverages' field value. If an end-user tries to hide the 'Beverages' field value, the event handler sets the event parameter's Cancel property to true to cancel changing the filter condition.

Expanded See Also

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