PivotGridControl.CustomFilterDisplayText Event

Enables custom text to be displayed in the Filter Panel.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

C#
VB.NET

csharp

public event ConvertEditValueEventHandler CustomFilterDisplayText

Public Event CustomFilterDisplayText As ConvertEditValueEventHandler

Event Data

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

Property	Description
Handled	Gets or sets a value specifying whether default edit value conversion/formatting is required.
Value	Gets or sets either the edit or the display value of an editor.

Remarks

In the following code snippet the CustomFilterDisplayText event is handled to display the “Filter is applied” string in the filter panel instead of the criteria string:

C#
VB.NET

csharp

private void pivotGridControl1_CustomFilterDisplayText(object sender, DevExpress.XtraEditors.Controls.ConvertEditValueEventArgs e) {
    if(e.Value != null) {
        e.Value = "Filter is applied";
    } else {
        e.Value = e.Value.ToString();
    }
    e.Handled = true;
}

Private Sub pivotGridControl1_CustomFilterDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.ConvertEditValueEventArgs)
    If e.Value IsNot Nothing Then
      e.Value = "Filter is applied"
    Else
      e.Value = e.Value.ToString()
    End If
    e.Handled = True
End Sub