FilterPopupListBoxEventArgs Class

Provides data for the ColumnView.ShowFilterPopupListBox event.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public class FilterPopupListBoxEventArgs :
    FilterPopupEventArgs

VB.NET

Public Class FilterPopupListBoxEventArgs
    Inherits FilterPopupEventArgs

Related API Members

FilterPopupListBoxEventArgs is the data class for the following events:

• ColumnView.ShowFilterPopupListBox

Remarks

The ColumnView.ShowFilterPopupListBox event fires before displaying a column’s filter dropdown list. It enables you to add your own items to the dropdown and delete existing items. Thus, the FilterPopupListBoxEventArgs class declares the FilterPopupListBoxEventArgs.ComboBox property that allows you to access the items list. You can also identify the column whose dropdown list is about to be displayed. Use the Column property for this purpose.

FilterPopupListBoxEventArgs objects are automatically created and passed to ColumnView.ShowFilterPopupListBox event handlers.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterPopupListBoxEventArgs 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.

C#

how-to-add-an-item-with-a-complex-filter-condition-to-the-column-filter-list-e899/CS/Form1.cs#L133

private void gridView1_ShowFilterPopupListBox(object sender, DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs e) {
    if(e.Column.FieldName == "Product Name") {

how-to-customize-the-gridviews-column-filter-dropdown-to-provide-a-custom-list-of-filters-e2169/CS/WindowsApplication1/Form1.cs#L31

private void gridView1_ShowFilterPopupListBox(object sender, FilterPopupListBoxEventArgs e) {
    if (e.Column.FieldName == "Column2") {

how-to-set-focus-to-filtered-value-in-the-filter-popup-list-box-e2851/CS/Form1.cs#L31

private void gridView1_ShowFilterPopupListBox(object sender, DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs e) {
    e.ComboBox.Tag = e.Column;

how-to-show-images-in-the-columns-filter-drop-down-list-e2573/CS/WindowsApplication3/Form1.cs#L35

private void OnShowFilterPopupListBox(object sender, DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs e) {
    e.ComboBox.DrawItem -= OnDrawItem;

VB.NET

how-to-add-an-item-with-a-complex-filter-condition-to-the-column-filter-list-e899/VB/Form1.vb#L126

Private Sub gridView1_ShowFilterPopupListBox(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs) Handles gridView1.ShowFilterPopupListBox
    If e.Column.FieldName = "Product Name" Then

how-to-customize-the-gridviews-column-filter-dropdown-to-provide-a-custom-list-of-filters-e2169/VB/WindowsApplication1/Form1.vb#L33

Private Sub gridView1_ShowFilterPopupListBox(ByVal sender As Object, ByVal e As FilterPopupListBoxEventArgs) Handles gridView1.ShowFilterPopupListBox
    If e.Column.FieldName = "Column2" Then

how-to-set-focus-to-filtered-value-in-the-filter-popup-list-box-e2851/VB/Form1.vb#L34

Private Sub gridView1_ShowFilterPopupListBox(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs) Handles gridView1.ShowFilterPopupListBox
    e.ComboBox.Tag = e.Column

how-to-show-images-in-the-columns-filter-drop-down-list-e2573/VB/WindowsApplication3/Form1.vb#L37

Private Sub OnShowFilterPopupListBox(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FilterPopupListBoxEventArgs) Handles gridView1.ShowFilterPopupListBox
    RemoveHandler e.ComboBox.DrawItem, AddressOf OnDrawItem

Inheritance

Object

EventArgs

FilterPopupEventArgs

FilterPopupListBoxEventArgs