DataViewBase.CustomFilterDisplayText Event

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

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event CustomFilterDisplayTextEventHandler CustomFilterDisplayText

VB.NET

Public Event CustomFilterDisplayText As CustomFilterDisplayTextEventHandler

Event Data

The CustomFilterDisplayText event's data class is CustomFilterDisplayTextEventArgs. 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 the View that raised the event.
Value	Gets or sets the filter expression displayed within the Filter 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 DataViewBase.FilterPanelText property returns the filter expression displayed in the legacy Filter Panel. To replace the filter expression displayed within the legacy Filter Panel with the custom text:

1. Handle the DataViewBase.CustomFilterDisplayText event.
2. Specify the CustomFilterDisplayTextEventArgs.Value property.

XAML

<dxg:GridControl FilterString="[OrderDate] &gt; #2020-01-01# And [Freight] &gt; 100.0m" ...>
    <dxg:GridControl.View>
        <dxg:TableView x:Name="view"
                       UseLegacyFilterPanel="True"
                       CustomFilterDisplayText="view_CustomFilterDisplayText">
        </dxg:TableView>
    </dxg:GridControl.View>
</dxg:GridControl>

C#

void view_CustomFilterDisplayText(object sender, DevExpress.Xpf.Grid.CustomFilterDisplayTextEventArgs e) {
    e.Value = "Custom text in the Filter Panel";
}

VB.NET

Private Sub view_CustomFilterDisplayText(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.CustomFilterDisplayTextEventArgs)
    e.Value = "Custom text in the Filter Panel"
End Sub