ColumnBase.FilterPopupMode Property

Gets or sets the display mode of the column’s filter dropdown. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public FilterPopupMode FilterPopupMode { get; set; }

VB.NET

Public Property FilterPopupMode As FilterPopupMode

Property Value

Type	Description
FilterPopupMode	A FilterPopupMode enumeration value that specifies the display mode of the column’s filter dropdown.

Available values:

Name	Description
Default	For date-time columns, this option is equivalent to the DateSmart option. For other columns, this option is equivalent to the List option.
List	A filter dropdown is represented as a regular list of items (one item at a time can be selected).
CheckedList	A filter dropdown is represented as a checked list (multiple items can be selected/checked simultaneously).
Custom	A filter dropdown is represented by a custom template assigned to the ColumnBase.CustomColumnFilterPopupTemplate property.
Date	This mode is equivalent to DateSmart regarding the appearance of the filter dropdown. The filter dropdown displays all the available check boxes, even if there is no data that falls into a corresponding date range.
DateAlt	This mode is equivalent to DateSmart, but with a different set of filters: Today, This week, This month, Next month, etc. Beyond - Dates that belong to the month in three months time and beyond. Earlier - Dates that belong to the month seven months ago and earlier.
DateSmart	The filter dropdown provides a built-in calendar plus check boxes to select common non-intersecting date intervals. The available date ranges for the DateSmart and Date modes: Beyond this year - Dates that follow the current year. Later this year - Dates of the current year starting from the following month. Later this month - Dates of the current month that follow the next week. Next week - Dates that belong to the following week. Later this week - Dates of the current week starting from the day after tomorrow. Tomorrow - Tomorrow. Today - Today. Yesterday - Yesterday. Earlier this week - Dates of the current week that are prior to yesterday. Last week - Dates of the previous week. Earlier this year - Dates of the current year that are prior to the current month. Prior to this year | Dates that are prior to the current year. If there is no underlying data that would fall into a specific date range, the corresponding check box is hidden. If all values in the date-time column are set to null, all check boxes are visible.
DateCompact	A date-time filter dropdown without predefined values.
Excel	An Excel-style Drop-down Filter (previous).
ExcelSmart	An Excel-style Drop-down Filter (new; works starting with v18.2).

Remarks

Tip

Topic: Drop-down Filter

By default, filter dropdowns of date-time columns are represented by the calendar, filter dropdowns of all other columns are represented by regular lists.

Use the FilterPopupMode property to specify the required appearance of a column’s filter dropdown.

The Drop-down Filter can be represented in the following ways.

Filter dropdown display mode	Column’s FilterPopupMode value
a regular list of items (one item at a time can be selected)	FilterPopupMode.List
a checked list (multiple items can be selected/checked simultaneously)	FilterPopupMode.CheckedList
a calendar (for date-time columns)	FilterPopupMode.Date FilterPopupMode.DateAlt FilterPopupMode.DateCompact FilterPopupMode.DateSmart
an Excel style filter dropdown	FilterPopupMode.Excel (previous) FilterPopupMode.ExcelSmart (new; works starting with v18.2)

If you don’t want to use built-in filter dropdowns, you can provide your own filter dropdown via templates. In this instance, set the FilterPopupMode property to FilterPopupMode.Custom / FilterPopupMode.ExcelSmart and assign the template to the ColumnBase.CustomColumnFilterPopupTemplate.

Related GitHub Examples

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

wpf-data-grid-bind-to-infiniteasyncsource/CS/MainWindow.xaml#L18

            AllowSorting="True" AllowedSortOrders="Descending"
            AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">
<dxg:GridColumn.EditSettings>

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

<dxg:GridColumn FieldName="Name" />
<dxg:GridColumn FieldName="StartDate" FilterPopupMode="List" />
<dxg:GridColumn FieldName="FinishDate" FilterPopupMode="List" />

grid-how-to-change-a-columns-filter-popup-using-customcolumnfilterpopuptemplate-e1794/CS/DateRangeFilterCS/Window1.xaml#L24

<dxg:GridColumn FieldName="Name"/>
<dxg:GridColumn FieldName="Date1" FilterPopupMode="Custom"
            CustomColumnFilterPopupTemplate="{StaticResource columnFilterPopupTemplate}" />

how-to-bind-to-infinitesource/CS/MainWindow.xaml#L18

            AllowSorting="True" AllowedSortOrders="Descending"
            AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">
<dxg:GridColumn.EditSettings>

wpf-data-grid-bind-to-pagedasyncsource/CS/MainWindow.xaml#L18

            AllowSorting="True" AllowedSortOrders="Descending"
            AllowedDateTimeFilters="SingleDateRange" FilterPopupMode="DateSmart">
<dxg:GridColumn.EditSettings>