Skip to main content
Tab

ASPxGridBase.FilterControlCustomValueDisplayText Event

Allows you to specify the entered filter value’s custom display text to be displayed when the filter control’s condition value editor is inactive.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

public event FilterControlCustomValueDisplayTextEventHandler FilterControlCustomValueDisplayText

Event Data

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

Property Description
DisplayText Gets or sets the display text of the entered filter value.
EncodeHtml Gets or sets a value that specifies whether the filter value display text keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers.
PropertyInfo Gets the filterable property of the filter expression.
Value Gets the custom value entered into the filter bar by an end user.

Remarks

The FilterControlCustomValueDisplayText event enables you to provide a custom display text for the filter value entered into the built-in filter control’s filter condition. This custom text is displayed within a condition value editor when it’s inactive.

The event’s Value property allows the currently entered value to be obtained. Set the DisplayText property to specify the value’s custom display text, if required.

protected void grid_FilterControlCustomValueDisplayText(object sender, FilterControlCustomValueDisplayTextEventArgs e) {
    if (e.PropertyInfo.PropertyName == "NeedAlert") {
        if (e.Value == null)
            return;
        e.DisplayText = (bool)e.Value ? "Need alert" : "Is's ok";
    }
}

Run Demo: Grid - Filter Control Run Demo: Card View - Filter Control Run Demo: Vertical Grid - Filter Control

See Also