WindowsFormsSettings.ColumnFilterPopupMode Property
Gets or sets the default display mode of column filter dropdowns in all GridControls, TreeLists and PivotGridControls in the current application.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.Utils.v24.2.dll
Declaration
Property Value
| Type | Description |
|---|---|
| ColumnFilterPopupMode | A value that specifies the default display mode of column filter dropdowns in all GridControls and TreeLists in the current application. |
Available values:
| Name | Description |
|---|---|
| Default | Equivalent to the ColumnFilterPopupMode.Excel setting. |
| Excel | Grid and TreeList columns display Excel-style filter menus. |
| Classic | Grid and TreeList columns display classic drop-down filter menus. |
Remarks
Column filter dropdowns (within the GridConrol and within the TreeList) 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.
Application level.
The current static WindowsFormsSettings.ColumnFilterPopupMode property specifies the default column filter dropdown style for all GridControls and TreeLists in your application.
Control level.
For the GridControl, use a View’s ColumnViewOptionsFilter.ColumnFilterPopupMode property (ColumnView.OptionsFilter.ColumnFilterPopupMode) to specify the default column filter dropdown style in this specific View.
For the TreeList control, use the TreeListOptionsFilter.ColumnFilterPopupMode property (TreeList.OptionsFilter.ColumnFilterPopupMode).
For the PivotGridControl control, use the PivotGridOptionsFilterPopup.FieldFilterPopupMode property (PivotGrid.OptionsFilterPopup.FieldFilterPopupMode).
These control level settings override the WindowsFormsSettings.ColumnFilterPopupMode global setting for the current control.
Column / field level.
For the GridControl, use a column’s OptionsColumnFilter.FilterPopupMode property (GridColumn.OptionsFilter.FilterPopupMode) to specify the filter dropdown style for this specific column.
For the TreeList control, use a column’s TreeListOptionsColumnFilter.FilterPopupMode property (TreeListColumn.OptionsFilter.FilterPopupMode).
For the PivotGridControl control, use a field’s PivotGridFieldOptionsEx.FieldFilterPopupMode property (PivotGridField.Options.FieldFilterPopupMode).
The column level settings override the corresponding control level settings for the current column.
The WindowsFormsSettings.ColumnFilterPopupMode property can be set to one of the following values:
Default - Enables the Excel mode for the v17 version of DevExpress components and later; for earlier versions, enables the Classic mode (see the Version Compatibility topic to learn about default values of various properties according to the selected DevExpress installation version).
Note
The Classic mode is also enabled by default regardless of the selected DevExpress installation version if a custom non-Excel style filter is provided using the following events:
for the GridControl:
- ColumnView.ShowFilterPopupCheckedListBox,
- ColumnView.ShowFilterPopupListBox,
- ColumnView.ShowFilterPopupDate;
for the TreeList:
- Classic - Sets classic (regular, checked, or calendar depending on settings or data type) filter dropdown styles as default,
- Excel - Sets the MS Excel-inspired filter dropdown style as default.
For more details on Excel-inspired filter dropdowns, see the GridControl’s Excel Style Filter DropDown and TreeList’s Excel Style Filter DropDown topics.