ASPxPivotGrid.CustomFilterExpressionDisplayText Event

Enables you to display custom text within the Prefilter panel, corresponding to the current filter expression.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v19.2.dll

Declaration

public event CustomFilterExpressionDisplayTextEventHandler CustomFilterExpressionDisplayText
Public Event CustomFilterExpressionDisplayText As CustomFilterExpressionDisplayTextEventHandler

Event Data

The CustomFilterExpressionDisplayText event handler receives an argument of the CustomFilterExpressionDisplayTextEventArgs type. The following properties provide information specific to this event.

Property Description
Criteria Gets the applied filter criteria.
DisplayText Gets or sets the filter expression displayed within the filter bar, representing the applied filter criteria.
EncodeHtml Gets 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.
FilterExpression Gets the text representation of the applied filter criteria, which can be obtained via the CustomFilterExpressionDisplayTextEventArgs.Criteria property.
Tooltip Gets or sets the tooltip text.

Remarks

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

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 Prefilter panel. To display custom text, use the CustomFilterExpressionDisplayTextEventArgs.DisplayText property.

See Also