Back to Devexpress

ASPxGridBase.CustomFilterExpressionDisplayText Event

aspnet-devexpress-dot-web-dot-aspxgridbase-131f63dd.md

latest3.2 KB
Original Source

ASPxGridBase.CustomFilterExpressionDisplayText Event

Enables you to display custom text in the filter bar, corresponding to the current filter expression.

Namespace : DevExpress.Web

Assembly : DevExpress.Web.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
public event CustomFilterExpressionDisplayTextEventHandler CustomFilterExpressionDisplayText
vb
Public Event CustomFilterExpressionDisplayText As CustomFilterExpressionDisplayTextEventHandler

Event Data

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

PropertyDescription
CriteriaGets the applied filter criteria.
DisplayTextGets or sets the filter expression displayed within the filter bar, representing the applied filter criteria.
EncodeHtmlGets or sets a value that specifies whether the filter expression displayed within the filter bar keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers.
FilterExpressionGets the text representation of the applied filter criteria, which can be obtained via the CustomFilterExpressionDisplayTextEventArgs.Criteria property.
TooltipGets or sets the tooltip text.

Remarks

The CustomFilterExpressionDisplayText event is raised each time the filter bar is being rendered, and allows you to change the filter string displayed in the bar.

The event parameter’s CustomFilterExpressionDisplayTextEventArgs.Criteria properties allow you to obtain the filter criteria currently applied. Its text representation is returned by the CustomFilterExpressionDisplayTextEventArgs.FilterExpression property. By default, this text is displayed within the filter bar. To display custom text, use the CustomFilterExpressionDisplayTextEventArgs.DisplayText property.

See Also

ASPxGridBase Class

ASPxGridBase Members

DevExpress.Web Namespace