MVCxTokenBoxProperties.CustomFiltering Event
Provides the capability to implement custom filtering logic before the server-side filtering is executed.
Namespace: DevExpress.Web.Mvc
Assembly: DevExpress.Web.Mvc5.v19.2.dll
Declaration
Event Data
The CustomFiltering event's data class is ListEditCustomFilteringEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| CustomHighlighting | Specifies rules according to which the editor highlights the filtered items. |
| Filter | Gets a string that is a filter condition for the editor’s items typed by a user. |
| FilterExpression | Gets or sets a value specifying the filter expression that is to be applied to the editor items. |
Remarks
Use the delegate specified by the CustomFiltering property to filter the editor items that match filter criteria and highlight them on the server side.
Use the ListEditCustomFilteringEventArgs.FilterExpression property to specify the filter expression based on the Criteria Operator syntax. If the ListEditCustomFilteringEventArgs.FilterExpression property is not specified, the “Contains/Starts with” comparison operator is used by default.
If the ListEditCustomFilteringEventArgs.CustomHighlighting property is not set, the CustomFiltering property enables you to highlight the first occurrence of the search text typed in the editor’s filtering area (regardless of the ListEditCustomFilteringEventArgs.FilterExpression property). Use the ListEditCustomFilteringEventArgs.CustomHighlighting property to specify the custom highlighting logic. Refer to this property description for more information.
Note
The delegate specified by the CustomFiltering property is re-raised if items are loaded on a callback when scrolling while the ListEditCustomFilteringEventArgs.CustomHighlighting property is not in effect in this case.