Edit

Share via


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.

public:
 property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };
public string? Filter { get; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] set; }
public string Filter { get; set; }
[<set: System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")>]
member this.Filter : string with get, set
member this.Filter : string with get, set
Public Property Filter As String

Property Value

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

Attributes

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

See also