ColumnBase.FilterPopupMode Property
Gets or sets the display mode of the column’s Drop-Down Filter. This is a dependency property.
Namespace: DevExpress.Xpf.Grid
Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core
Declaration
Property Value
Type | Description |
---|---|
FilterPopupMode | A FilterPopupMode enumeration value that specifies the display mode of the column’s drop-down filter. |
Available values:
Name | Description |
---|---|
Default | ExcelSmart starting with v19.2. In previous versions, DateSmart for date-time columns, and List for other columns. |
List | A regular list of items (one item at a time can be selected). |
CheckedList | A checked list. Multiple items can be selected/checked simultaneously. |
Custom | A drop-down filter is represented by a custom template assigned to the ColumnBase.CustomColumnFilterPopupTemplate property. |
Date | This mode is equivalent to DateSmart regarding the appearance of the drop-down filter. The drop-down filter 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.
|
DateSmart | A built-in calendar plus check boxes to select common non-intersecting date intervals. The available date ranges for the DateSmart and Date modes:
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 drop-down filter 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
v19.2 and later use the Excel-style Drop-down Filter by default.
To use the previous drop-down filter:
- For a specific GridControl, specify the ColumnBase.FilterPopupMode / DataViewBase.ColumnFilterPopupMode property.
- For all GridControls, set the CompatibilitySettings.UseLegacyColumnFilterPopup property to true.
Drop-Down Filter Display Mode | FilterPopupMode Value |
---|---|
an Excel style drop-down filter | FilterPopupMode.Excel (previous) FilterPopupMode.ExcelSmart (new; works starting with v18.2) |
a regular list of items (one item at a time can be selected) | |
a checked list (multiple items can be selected/checked simultaneously) | |
a calendar (for date-time columns) |
Tip
If you do not want to use built-in drop-down filters, you can provide your own drop-down filter via templates. 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.