TreeList.ActiveFilter Property

Retrieves the filtering criteria currently applied to this TreeList.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v20.1.dll

Declaration

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

Property Value

Type Description
DevExpress.XtraTreeList.TreeFilter

A DevExpress.XtraTreeList.TreeFilter object that is the filtering criteria applied to this TreeList.

Remarks

The ActiveFilter method returns an object of the TreeFilter type, that allows you to retrieve the following information.

  • Tree List columns whose data is filtered.
  • Filtering expressions (Like, Equals, Starts With, etc.) applied to columns.
  • String representations of the applied filtering expressions. These strings are displayed within the TreeList filter panel.

You can manually edit the ActiveFilter property to apply specific filtering conditions to TreeList columns.

See Also