ColumnView.ActiveFilterEnabled Property

Gets or sets whether the filtering functionality is enabled.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Boolean	**true**	true if the filtering functionality is enabled; otherwise, false.

Remarks

If the filtering functionality is enabled, the View displays only the data that meets the current filter criteria, specified by the ColumnView.ActiveFilter property. Set the ActiveFilterEnabled property to false to temporarily disable filtering. In this case the View will display all the records from the underlying data source.

An end-user can disable filtering by unchecking the Enable Filter check box within the filter panel.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveFilterEnabled property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-get-a-list-of-data-rows-shown-in-a-filtered-grid-e691/CS/FilteredDataSourceHelperComponent/FilteredDataSourceHelper.cs#L28

if (view == null) return null;
if (view.ActiveFilter == null || !view.ActiveFilterEnabled
    || view.ActiveFilter.Expression == "")

how-to-warn-a-user-if-the-newly-inserted-row-is-filtered-out-e1711/CS/Form1.cs#L37

GridView view = (GridView)sender;
if(view.ActiveFilterEnabled && view.FocusedRowHandle == GridControl.NewItemRowHandle) {
    if(IsRowFilteredOut(view, e.Row))

VB.NET

how-to-get-a-list-of-data-rows-shown-in-a-filtered-grid-e691/VB/FilteredDataSourceHelperComponent/FilteredDataSourceHelper.vb#L30

End If
If view.ActiveFilter Is Nothing OrElse Not view.ActiveFilterEnabled OrElse view.ActiveFilter.Expression = "" Then
    Return TryCast(view.DataSource, DataView)

how-to-warn-a-user-if-the-newly-inserted-row-is-filtered-out-e1711/VB/Form1.vb#L41

Dim view As GridView = CType(sender, GridView)
If view.ActiveFilterEnabled AndAlso view.FocusedRowHandle = GridControl.NewItemRowHandle Then
    If IsRowFilteredOut(view, e.Row) Then