IBindingListView.Filter Property

Definition

Gets or sets the filter to be used to exclude items from the collection of items returned by the data source.

C#
public string? Filter { get; set; }
C#
public string Filter { get; set; }

Property Value

The string used to filter items out in the item collection returned by the data source.

Remarks

Your implementation of the Filter property should exhibit the following behavior when the Filter property is set: The data source returns only the items that meet the filter criteria when the list is accessed by item index or when the list is enumerated. The definition of the filter string is dependent on the data-source implementation, but the behavior associated with setting the filter should be modeled on DataColumn.Expression.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also