ASPxGridView.HeaderFilterFillItems Event

Allows you to add custom header filter items to default items.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

public event ASPxGridViewHeaderFilterEventHandler HeaderFilterFillItems

VB.NET

Public Event HeaderFilterFillItems As ASPxGridViewHeaderFilterEventHandler

Event Data

The HeaderFilterFillItems event's data class is ASPxGridViewHeaderFilterEventArgs. The following properties provide information specific to this event:

Property	Description
Column	Gets the data column currently being filtered.
Values	Gets a collection that contains the header filer values. Inherited from ASPxGridHeaderFilterEventArgs.

The event data class exposes the following methods:

Method	Description
AddShowAll()	Adds the ‘All’ item to the header filter. Inherited from ASPxGridHeaderFilterEventArgs.
AddShowBlanks(String)	Creates and adds the “Blanks” filter value to the header filter values. Inherited from ASPxGridHeaderFilterEventArgs.
AddShowNonBlanks(String)	Creates and adds the “(Non blanks)” filter value to the header filter values. Inherited from ASPxGridHeaderFilterEventArgs.
AddValue(String, String, String)	Adds a new filter item with the specified filter criteria to the header filter. Inherited from ASPxGridHeaderFilterEventArgs.
AddValue(String, String)	Adds a new filter item to the header filter. Inherited from ASPxGridHeaderFilterEventArgs.
CreateShowBlanksValue(String)	Creates and returns the (Blanks) filter item used to filter a column by blank values. Inherited from ASPxGridHeaderFilterEventArgs.
CreateShowNonBlanksValue(String)	Creates and returns the (Non blanks) filter item used to filter a column by blank values. Inherited from ASPxGridHeaderFilterEventArgs.

Remarks

The header filter allows users to filter column data. When a user clicks on the filter button, the grid displays a filter dropdown. The HeaderFilterFillItems event fires after the grid creates default filter items and before the filter dropdown is shown. The event allows you to customize the default filter item set.

Custom filter items can filter data by the current column only.

Note

If the ASPxGridBeforeHeaderFilterFillItemsEventArgs.Handled property is set to true, the HeaderFilterFillItems event does not fire.

Run Demo: Header Filter

Example

This example creates custom filter items and displays them within the Units On Order column’s filter dropdown.

C#

protected void ASPxGridView1_HeaderFilterFillItems(object sender, DevExpress.Web.ASPxGridViewHeaderFilterEventArgs e) {
        if (e.Column.FieldName != "Quantity") return;
        e.AddValue("nonzero", string.Empty, "[Quantity] != 0");
        e.AddValue(String.Format("from {0} to {1}", 0, 50), string.Empty, String.Format("[Quantity] > {0} and [Quantity] < {1}", 0, 50));
        e.AddValue(String.Format(">= {0}", 50), string.Empty, String.Format("[Quantity] >= {0}", 50));
}

VB.NET

Protected Sub ASPxGridView1_HeaderFilterFillItems(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridViewHeaderFilterEventArgs)
    If e.Column.FieldName <> "Quantity" Then Return
    e.AddValue("nonzero", String.Empty, "[Quantity] != 0")
    e.AddValue(String.Format("from {0} to {1}", 0, 50), String.Empty, String.Format("[Quantity] > {0} and [Quantity] < {1}", 0, 50))
    e.AddValue(String.Format(">= {0}", 50), String.Empty, String.Format("[Quantity] >= {0}", 50))
End Sub