GridViewSettings.BeforeHeaderFilterFillItems Property

Enables you to provide custom filter items instead of default ones displayed within a Popup Header Filter.

Namespace: DevExpress.Web.Mvc

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

Declaration

public ASPxGridViewBeforeHeaderFilterFillItemsEventHandler BeforeHeaderFilterFillItems { get; set; }
Public Property BeforeHeaderFilterFillItems As ASPxGridViewBeforeHeaderFilterFillItemsEventHandler

Property Value

Type Description
ASPxGridViewBeforeHeaderFilterFillItemsEventHandler

An ASPxGridViewBeforeHeaderFilterFillItemsEventHandler delegate method allowing you to implement custom processing.

Remarks

End-users can filter column values via the Header Filter. To invoke the filter dropdown, an end-user clicks on the filter button. The BeforeHeaderFilterFillItems event is raised before the 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 ASPxGridViewHeaderFilterEventArgs.Column property. To add a new filter value, use the ASPxGridHeaderFilterEventArgs.AddValue method.

Set the ASPxGridBeforeHeaderFilterFillItemsEventArgs.Handled property to true to prevent the ASPxGridView.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 GridViewSettings.HeaderFilterFillItems event.

Note

The GridView header filter allows the use of HTML tags in an item text.

See Also