Skip to main content

ListBoxSettings.CustomFiltering Property

Enables you to implement custom filtering logic.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

public ListEditCustomFilteringEventHandler CustomFiltering { get; set; }

Property Value

Type Description
ListEditCustomFilteringEventHandler

A ListEditCustomFilteringEventHandler delegate method allowing you to implement custom processing.

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.

See Also