ASPxVerticalGrid.HeaderFilterFillItems Event
Enables you to add custom filter items which filter data by the current row to ones displayed within a header filter.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v18.2.dll
Declaration
Event Data
The HeaderFilterFillItems event's data class is ASPxVerticalGridHeaderFilterEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Row | Gets the data row 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
End-users can filter row values via the header filter. To invoke the header filter, an end-user should click the filter button. The HeaderFilterFillItems event is raised after default filter items are created and before the header filter is shown; and enables you to add custom filter items.
Note
The custom filter items can be used for filtering data by the current row only.
The row whose filter button has been clicked is returned by the ASPxVerticalGridHeaderFilterEventArgs.Row property. The list of filter values can be accessed using the ASPxGridHeaderFilterEventArgs.Values property. To add a new filter value, use the ASPxGridHeaderFilterEventArgs.AddValue method.
To build complex filter expressions, use the Filter Control.
Note
ASPxVerticalGrid header filter allows the use of HTML tags in an item text. To learn more, see Header Filter.
Note
If the ASPxGridBeforeHeaderFilterFillItemsEventArgs.Handled property is set to true, the HeaderFilterFillItems event is not raised.