PivotCustomFilterPopupItemsEventArgs Class

Provides data for the PivotGridControl.CustomFilterPopupItems event.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v19.1.dll

Declaration

C#

public class PivotCustomFilterPopupItemsEventArgs :
    RoutedEventArgs

VB.NET

Public Class PivotCustomFilterPopupItemsEventArgs
    Inherits RoutedEventArgs

Related API Members

PivotCustomFilterPopupItemsEventArgs is the data class for the following events:

• PivotGridControl.CustomFilterPopupItems

Remarks

The PivotGridControl.CustomFilterPopupItems event allows you to customize the filter drop-down list items. The PivotCustomFilterPopupItemsEventArgs class provides the PivotCustomFilterPopupItemsEventArgs.Items property used to access the filter items collection. 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 a filter item from the drop-down list, remove the corresponding element from the collection.

To specify the check state of individual filter items, use their PivotGridFilterItem.IsChecked properties. To do this for all filter items, use the PivotCustomFilterPopupItemsEventArgs.CheckAllItems method.

You can also obtain the field for which the event has been raised using the 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.

Note

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PivotCustomFilterPopupItemsEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-sort-filter-drop-down-items-in-a-custom-manner-e2744/VB/DXPivotGrid_CustomFilterItemsSorting/MainWindow.xaml.vb#L18

Private Sub pivotGridControl1_CustomFilterPopupItems(ByVal sender As Object, _
        ByVal e As PivotCustomFilterPopupItemsEventArgs)
    If rbCaptionLength.IsChecked = True Then

Inheritance

Object

EventArgs

RoutedEventArgs

PivotCustomFilterPopupItemsEventArgs