Skip to main content

FilterControl.FilterColumns Property

Gets a filter column collection.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[Browsable(false)]
public FilterColumnCollection FilterColumns { get; }

Property Value

Type Description
DevExpress.XtraEditors.Filtering.FilterColumnCollection

A DevExpress.XtraEditors.Filtering.FilterColumnCollection object that represents the collection of filter columns.

Remarks

When a source control is assigned to the FilterControl.SourceControl property, the FilterColumns collection is automatically populated with the source control’s columns. By default, the FilterControl.SortFilterColumns property is set to true, and this ensures that the created columns in the collection will be sorted by captions in ascending order. Subsequent changes to the FilterControl.SortFilterColumns property don’t re-sort the column collection.

A FilterControl supports unbound mode. When the control is not bound to any source control, it still allows an end-user to construct filter criteria. In this instance, columns must be added to the FilterColumns collection manually via the FilterControl.SetFilterColumnsCollection method.

The following example demonstrates how to create unbound filter columns:

using DevExpress.XtraEditors.Filtering;
using DevExpress.XtraEditors.Repository;
using DevExpress.Data.Filtering.Helpers;

private void CreateFilterColumns() {
    filterControl1.FilterColumns.Add(new UnboundFilterColumn("Name", "Field1", typeof(string), new RepositoryItemTextEdit(), FilterColumnClauseClass.String));
    filterControl1.FilterColumns.Add(new UnboundFilterColumn("Age", "Field2", typeof(int), new RepositoryItemSpinEdit(), FilterColumnClauseClass.Generic));
}

Run Demo

See Also