ColumnViewOptionsFilter.ColumnFilterPopupMode Property

Gets or sets the default display mode of filter dropdowns for columns in the current View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DefaultValue(ColumnFilterPopupMode.Default)]
[XtraSerializableProperty]
public ColumnFilterPopupMode ColumnFilterPopupMode { get; set; }

VB.NET

<DefaultValue(ColumnFilterPopupMode.Default)>
<XtraSerializableProperty>
Public Property ColumnFilterPopupMode As ColumnFilterPopupMode

Property Value

Type	Default	Description
ColumnFilterPopupMode	**Default**	A value that specifies the default display mode of filter dropdowns for columns in the current View.

Available values:

Name	Description
Default	The type of column filter menus depends on the global WindowsFormsSettings.ColumnFilterPopupMode setting.
Excel	Columns display Excel-style filter menus.
Classic	Columns display classic drop-down filter menus.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ColumnFilterPopupMode
AdvBandedGridView	.OptionsFilter.ColumnFilterPopupMode
BandedGridView	.OptionsFilter.ColumnFilterPopupMode
ColumnView	.OptionsFilter.ColumnFilterPopupMode
CardView	.OptionsFilter.ColumnFilterPopupMode
GridView	.OptionsFilter.ColumnFilterPopupMode
LayoutView	.OptionsFilter.ColumnFilterPopupMode
TileView	.OptionsFilter.ColumnFilterPopupMode
WinExplorerView	.OptionsFilter.ColumnFilterPopupMode

Remarks

Column filter dropdowns can be presented using the following display modes (the first two modes are also called classic).

• Regular list
• Calendar (for date-time columns) - A window with an embedded calendar along with predefined filter items for quick selection of common date intervals
• Checked list
• MS Excel-inspired style

The style of column filter dropdowns can be set at three levels.

1. Application level

   The static WindowsFormsSettings.ColumnFilterPopupMode property specifies the default column filter dropdown style for all GridControls in your application.

2. Control level

   The current property (ColumnViewOptionsFilter.ColumnFilterPopupMode) specifies the default column filter dropdown style in a certain View. This setting overrides the WindowsFormsSettings.ColumnFilterPopupMode global setting.

3. Column level

   A column’s OptionsColumnFilter.FilterPopupMode property (GridColumn.OptionsFilter.FilterPopupMode) specifies the filter dropdown style for a specific column. This setting overrides the ColumnViewOptionsFilter.ColumnFilterPopupMode setting.

The ColumnViewOptionsFilter.ColumnFilterPopupMode property can be set to one of the following values:

• Default - The actual column filter dropdown style is specified by the WindowsFormsSettings.ColumnFilterPopupMode global setting.
• Classic - Sets classic display styles as default in the current View. The classic presentation styles will be applied to columns that have the GridColumn.OptionsFilter.FilterPopupMode property set to Default. Otherwise, column filter dropdowns will be presented according to the GridColumn.OptionsFilter.FilterPopupMode property.
• Excel - Sets the MS Excel-inspired filter dropdown style as default in the current View. This presentation mode will be applied to columns that have the GridColumn.OptionsFilter.FilterPopupMode property set to Default. Otherwise, column filter dropdowns will be presented according to the GridColumn.OptionsFilter.FilterPopupMode property.

For more details on Excel-inspired filter dropdowns, see Filter and Search.

Related GitHub Examples

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

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-custom-filter-items-into-the-datetime-filter-popup-window-e4265/CS/RangeDate/Form1.cs#L110

    myGridView1.Columns["Range Date"].OptionsFilter.UseFilterPopupRangeDateMode = true;
    myGridView1.OptionsFilter.ColumnFilterPopupMode = DevExpress.XtraGrid.Columns.ColumnFilterPopupMode.Classic;
}

how-to-implement-excel-style-tree-filtering-in-a-filter-popup-t143068/CS/RangeDate/Form1.cs#L39

    myGridControl1.DataSource = dataTable;
    myGridView1.OptionsFilter.ColumnFilterPopupMode = DevExpress.XtraGrid.Columns.ColumnFilterPopupMode.Classic;
}

VB.NET

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/VB/RangeDate/Form1.vb#L108

    myGridView1.Columns("Range Date").OptionsFilter.UseFilterPopupRangeDateMode = True
    myGridView1.OptionsFilter.ColumnFilterPopupMode = DevExpress.XtraGrid.Columns.ColumnFilterPopupMode.Classic
End Sub

how-to-implement-excel-style-tree-filtering-in-a-filter-popup-t143068/VB/RangeDate/Form1.vb#L36

    myGridControl1.DataSource = dataTable
    myGridView1.OptionsFilter.ColumnFilterPopupMode = DevExpress.XtraGrid.Columns.ColumnFilterPopupMode.Classic
End Sub