Back to Devexpress

OptionsColumnFilter.PopupExcelFilterGrouping Property

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-optionscolumnfilter-2ded79d4.md

latest3.1 KB
Original Source

OptionsColumnFilter.PopupExcelFilterGrouping Property

Gets or sets data field (column) names separated by a comma, semicolon, space or tab character by which filter values are grouped in the column’s filter menu.

Namespace : DevExpress.XtraGrid.Columns

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue("")]
[XtraSerializableProperty]
public virtual string PopupExcelFilterGrouping { get; set; }
vb
<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property PopupExcelFilterGrouping As String

Property Value

TypeDefaultDescription
StringString.Empty

A String value specifying data field names separated by a comma, semicolon, space or tab character by which filter values are grouped in the column’s filter menu.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to PopupExcelFilterGrouping
GridColumn

.OptionsFilter .PopupExcelFilterGrouping

|

Remarks

Use the PopupExcelFilterGrouping property to group filter values in the current column’s filter menu by another column. The code snippet below groups cities by countries.

csharp
colCity.OptionsFilter.PopupExcelFilterGrouping = "Country;City";
vb
colCity.OptionsFilter.PopupExcelFilterGrouping = "Country;City"

As a result, filter values are displayed in a tree structure.

In the case of a Code First data source, you can annotate data fields with the FilterGroup attribute using the same syntax in the attribute parameter.

csharp
[Utils.Filtering.FilterGroup("Country;City")]
public string City { get; set; }
vb
<Utils.Filtering.FilterGroup("Country;City")>
Public Property City As String

See Also

OptionsColumnFilter Class

OptionsColumnFilter Members

DevExpress.XtraGrid.Columns Namespace