ColumnView.ActiveFilter Property

Gets an object which returns information on the filter criteria applied to the View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[XtraSerializableProperty(XtraSerializationVisibility.Hidden)]
[DXCategory("Behavior")]
public ViewFilter ActiveFilter { get; }
<XtraSerializableProperty(XtraSerializationVisibility.Hidden)>
<DXCategory("Behavior")>
Public ReadOnly Property ActiveFilter As ViewFilter

Property Value

Type Description
ViewFilter

A ViewFilter object representing the filter criteria for the current View.

Remarks

To specify the filter criteria, use the ColumnView.ActiveFilterString or ColumnView.ActiveFilterCriteria property.

The ActiveFilter property of the ViewFilter class provides a number of properties which return details on the current filter criteria applied to the view:

For more information, see the Filter and Search document.

Examples

The following code shows how to add a filter condition to a View via its ColumnView.ActiveFilter object. The filter condition selects records whose CategoryName fields start with 'c'.

using DevExpress.XtraGrid.Views.Base;
using DevExpress.XtraGrid.Columns;
//...
ColumnView view = gridView1;
view.ActiveFilter.Add(view.Columns["CategoryName"], 
  new ColumnFilterInfo("[CategoryName] Like 'c%'", ""));
See Also