PivotGridControl.ShowFilterPopupExcel Event

Allows you to customize the Excel-style filter popup (for instance, to hide specific filtering conditions from the “Filters” tab).

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

[DXCategory("Behavior")]
public event FilterPopupExcelEventHandler ShowFilterPopupExcel

VB.NET

<DXCategory("Behavior")>
Public Event ShowFilterPopupExcel As FilterPopupExcelEventHandler

Event Data

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

Property	Description
DefaultFilterType	Gets or sets the filter operator selected by default in the Filters tab.
Field	Get the Pivot Grid field being processed.
IsRadioMode	Gets or sets whether single (the radio mode) or multiple filter values can be selected simultaneously.
ShowAdvancedDatePeriods
ShowAggregates	For internal use.
ShowBlanks	Gets or sets whether to show the ‘Is Blank’ and ‘Is Not Blank’ filter conditions.
ShowComparisons	Gets or sets whether to show comparison filter conditions (Greater Than, Less Than, etc.).
ShowCustomFilters	Gets or sets whether to show the ‘Custom Filter’.
ShowDatePeriods
ShowFiltersTab	Gets or sets whether to show the Filters tab.
ShowLikeFilters	Gets or sets whether to show the pattern-matching (Is Like, Is Not Like) operators for string values.
ShowNulls	Gets or sets whether to show the ‘Is Null’ and ‘Is Not Null’ filter conditions.
ShowPredefinedFilters	Gets or sets whether to show the ‘Predefined Filters’.
ShowSequences	For internal use.

Remarks

The ShowFilterPopupExcel event allows you to customize the Excel-style filter popup in various ways. For instance, you can use the FilterPopupExcelEventArgs.IsRadioMode event parameter to disable multiselection. Other event parameters (such as FilterPopupExcelEventArgs.ShowNulls, FilterPopupExcelEventArgs.ShowBlanks) allows you to hide specific filtering conditions from the “Filters” tab.

Example

The code snippet below shows how to enable the radio mode in the Excel-style filter popup by handling the PivotGridControl.ShowFilterPopupExcel event. In this example, FilterPopupExcelEventArgs.IsRadioMode event parameter is set to true to disable multiselection for the ‘fieldTrademark’ field .

IsRadioMode = false	IsRadioMode = true

C#

private void PivotGridControl_ShowFilterPopupExcel(object sender, FilterPopupExcelEventArgs e) {
    if (e.Field == fieldTrademark) {
        e.IsRadioMode = true;
    }
}

VB.NET

Private Sub PivotGridControl_ShowFilterPopupExcel(ByVal sender As Object, ByVal e As FilterPopupExcelEventArgs)
    If e.Field = fieldTrademark Then
        e.IsRadioMode = True
    End If
End Sub