DataViewBase.ShowFilterPopup Event

Enables you to customize a column’s filter dropdown.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.Core.dll

Declaration

C#

public event FilterPopupEventHandler ShowFilterPopup

VB.NET

Public Event ShowFilterPopup As FilterPopupEventHandler

Event Data

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

Property	Description
Column	Provides access to a grid column whose values should be filtered.
ComboBoxEdit	Gets the filter dropdown.
ExcelColumnFilterSettings	Provides access to the settings of the Excel-style filter.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
PopupBaseEdit	Gets the filter pop-up.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets the View that raised the event.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The ShowFilterPopup event is raised before a column’s filter dropdown is shown, allowing you to customize its filter items. For example, you can delete existing items, change the popup’s minimum width and height, add new items with custom captions and filter values, etc.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowFilterPopup event.

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.

C#

how-to-add-the-custom-menu-item-to-columns-filter-dropdown-list-e4800/CS/DXGrid.CustomFilter/MainWindow.xaml#L31

<dxg:GridControl.View>
    <dxg:TableView ShowTotalSummary="True" Name="view" AllowColumnFiltering="True" ShowFilterPopup="view_ShowFilterPopup" />
</dxg:GridControl.View>

how-to-customize-filter-items-within-a-columns-filter-dropdown-e1533/CS/DXGrid_CustomizingFilterDropdown/Window1.xaml#L14

<dxg:GridControl.View>
    <dxg:TableView AutoWidth="True" ShowFilterPopup="TableView_ShowFilterPopup" />
</dxg:GridControl.View>