TreeListSettings.BeforeHeaderFilterFillItems Property
Enables you to provide custom filter items instead of default ones displayed within the Header Filter.
Namespace: DevExpress.Web.Mvc
Assembly: DevExpress.Web.Mvc5.v24.1.dll
NuGet Package: DevExpress.Web.Mvc5
Declaration
public ASPxTreeListBeforeHeaderFilterFillItemsEventHandler BeforeHeaderFilterFillItems { get; set; }Property Value
| Type | Description |
|---|---|
| ASPxTreeListBeforeHeaderFilterFillItemsEventHandler | An ASPxTreeListBeforeHeaderFilterFillItemsEventHandler delegate method allowing you to implement custom processing. |
Remarks
End-users can filter column values using the Header Filter. To invoke the header filter dropdown, an end-user clicks on the filter button. The BeforeHeaderFilterFillItems event is raised before the header filter dropdown is shown and default filter items are created. The event enables you to provide custom filter items.
The data column whose filter button has been clicked is returned by the ASPxTreeListBeforeHeaderFilterFillItemsEventArgs.Column property. To add a new filter value, use the ASPxGridBeforeHeaderFilterFillItemsEventArgs.AddValue method.
Set the ASPxGridBeforeHeaderFilterFillItemsEventArgs.Handled property to true to prevent the TreeListSettings.HeaderFilterFillItems event from being raised. Otherwise, the event clears the item collection before filling it with default items.
If you would like to add custom items to the default items, use the TreeListSettings.HeaderFilterFillItems event.
Note
The Tree List header filter allows the use of HTML tags in an item text.