VGridControl.ActiveFilterEnabled Property

Gets or sets whether the filtering functionality is enabled.

Namespace : DevExpress.XtraVerticalGrid

Assembly : DevExpress.XtraVerticalGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

[DefaultValue(true)]
[DXCategory("Behavior")]
[XtraSerializableProperty]
[XtraSerializablePropertyId(3)]
public virtual bool ActiveFilterEnabled { get; set; }

<DefaultValue(True)>
<XtraSerializableProperty>
<XtraSerializablePropertyId(3)>
<DXCategory("Behavior")>
Public Overridable Property ActiveFilterEnabled As Boolean

Property Value

Type	Default	Description
Boolean	true

true if the filtering functionality is enabled; otherwise, false.

Remarks

Set the ActiveFilterEnabled property to false to temporarily disable filtering. To dismiss the data filter, call the VGridControl.ClearRowsFilter method.

Changing the ActiveFilterEnabled property value raises the VGridControl.RowFilterChanged event.

To completely disable filtering for the whole control or a particular row, use the VGridOptionsFilter.AllowFilter and VGridOptionsRowFilter.AllowFilter properties, respectively.