DataControlBase.IsFilterEnabled Property

Gets or sets whether the current filter is enabled. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.2.Core.dll

Declaration

C#

public bool IsFilterEnabled { get; set; }

VB.NET

Public Property IsFilterEnabled As Boolean

Property Value

Type	Description
Boolean	true to enable the current filter; otherwise, false.

Remarks

Set the IsFilterEnabled property to false, to temporarily disable the current filter in code. To enable the filter, set this property to true. End-users can do this by toggling the filter button as shown in the image below:

To learn more, see Regular and Checked Drop-down Filters and Filtering.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsFilterEnabled 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-show-images-in-a-column-filter-drop-down-window-e3941/CS/Default MVVM/FilterPopupConverter.cs#L49

GridColumn column = grid.Columns["Number"];
if (grid.IsFilterEnabled && !column.IsFiltered)
{

how-to-specify-row-visibility-in-the-viewmodel-e4174/CS/Grid MVVM Filtering/FilteredDataSupport.cs#L30

GridControl grid = sender as GridControl;
if(grid.IsFilterEnabled == true)
    ChangeVisibleData(grid);

how-to-synchronize-gridcontrol-selection-and-filters-with-schedulercontrol-t328445/CS/SchedulerViewModel.cs#L77

GridControl grid = args.Source as GridControl;
if (grid.IsFilterEnabled)
    Scheduler.Storage.AppointmentStorage.Filter = grid.FilterString;

VB.NET

how-to-show-images-in-a-column-filter-drop-down-window-e3941/VB/Default MVVM/FilterPopupConverter.vb#L48

Dim column As GridColumn = grid.Columns("Number")
If grid.IsFilterEnabled AndAlso (Not column.IsFiltered) Then
    Dim descriptors As PropertyDescriptorCollection = TypeDescriptor.GetProperties(source(0).GetType())

how-to-specify-row-visibility-in-the-viewmodel-e4174/VB/Grid MVVM Filtering/FilteredDataSupport.vb#L31

Dim grid As GridControl = TryCast(sender, GridControl)
If grid.IsFilterEnabled = True Then
    ChangeVisibleData(grid)

how-to-synchronize-gridcontrol-selection-and-filters-with-schedulercontrol-t328445/VB/SchedulerViewModel.vb#L100

Dim grid As GridControl = TryCast(args.Source, GridControl)
If grid.IsFilterEnabled Then
    Scheduler.Storage.AppointmentStorage.Filter = grid.FilterString