PivotGridControl.FieldFilterChanging Event

Allows you to cancel changing the filter condition.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

C#

public event PivotFieldFilterChangingEventHandler FieldFilterChanging

VB.NET

Public Event FieldFilterChanging As PivotFieldFilterChangingEventHandler

Event Data

The FieldFilterChanging event's handler receives an argument of the PivotFieldFilterChangingEventArgs type. The following 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. Inherited from PivotFieldEventArgs.
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. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
Values	Gets the collection of filter values, about to be assigned to the filter.

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 PivotGridControl.FieldFilterChanged event is fired.