PivotGridSettings.CustomFilterPopupItems Property

Allows you to customize the filter drop-down list items.

Namespace: DevExpress.Web.Mvc

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


public EventHandler<PivotCustomFilterPopupItemsEventArgs> CustomFilterPopupItems { get; set; }
Public Property CustomFilterPopupItems As EventHandler(Of PivotCustomFilterPopupItemsEventArgs)

Property Value

Type Description

A EventHandler<TEventArgs><PivotCustomFilterPopupItemsEventArgs,> delegate method allowing you to implement custom processing.


The CustomFilterPopupItems event is raised when an end-user invokes the filter drop-down list. The event parameter's PivotCustomFilterPopupItemsEventArgs.Items property returns a collection of filter items. Elements of the collection are represented by the PivotGridFilterItem objects. Initially, the filter items collection contains items representing the unique values stored in the underlying data source in the current field. To hide particular items from the filter drop-down, remove them from the collection.

You can also specify the check state of filter items using their PivotGridFilterItem.IsChecked property. The event parameter provides the PivotCustomFilterPopupItemsEventArgs.CheckAllItems method, which allows you to specify the check state of all filter items in the collection.

To obtain the field for which the filter drop-down is being populated, use the event parameter's PivotCustomFilterPopupItemsEventArgs.Field property.

The filter drop-down list contains the 'Show Blanks' item used to control whether the data records that contain null values in the respective field are processed by the pivot grid. To access the 'Show Blanks' filter item, use the PivotCustomFilterPopupItemsEventArgs.ShowBlanksItem property.


In the OLAP mode, the PivotCustomFilterPopupItemsEventArgs.ShowBlanksItem property returns null.

See Also