PivotGridControl.CustomPrefilterDisplayText Event

Allows you to display custom text instead of a filter expression in the legacy Filter Panel (Prefilter Panel).

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

[Browsable(false)]
public event CustomPrefilterDisplayTextEventHandler CustomPrefilterDisplayText

VB.NET

<Browsable(False)>
Public Event CustomPrefilterDisplayText As CustomPrefilterDisplayTextEventHandler

Event Data

The CustomPrefilterDisplayText event's data class is CustomPrefilterDisplayTextEventArgs. The following properties provide information specific to this event:

Property	Description
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.
Value	Gets or sets the text that should be displayed in the Prefilter Panel.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The text displayed within the legacy Filter Panel (Prefilter Panel) is returned by the PivotGridControl.FilterPanelText property. To replace this text with the custom text:

1. Handle the PivotGridControl.CustomFilterPanelDisplayText event.
2. Specify the CustomFilterDisplayTextEventArgs.Value property.

Tip

The Prefilter Panel is a legacy approach, use the new Filter Panel instead.

The PivotGridControl.CustomFilterPanelDisplayText event is equivalent to the PivotGridControl.CustomPrefilterDisplayText event. We added a new set of members when we introduced the new Filter Panel.