IBindingListView.Filter Property (System.ComponentModel)

Filter Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

IBindingListView..::.Filter Property

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

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Property Filter As String

Visual Basic (Usage)

Dim instance As IBindingListView
Dim value As String

value = instance.Filter

instance.Filter = value

string Filter { get; set; }

Visual C++

property String^ Filter {
    String^ get ();
    void set (String^ value);
}

JScript

function get Filter () : String
function set Filter (value : String)

Property Value

Type: System..::.String
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 Sort.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

IBindingListView Interface

IBindingListView Members

System.ComponentModel Namespace

DataView..::.Sort