BindingSource.Filter プロパティ

定義

表示する行のフィルター処理に使用する式を取得または設定します。Gets or sets the expression used to filter which rows are viewed.

public:
 virtual property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };
public virtual string Filter { get; set; }
member this.Filter : string with get, set
Public Overridable Property Filter As String

プロパティ値

行のフィルター処理方法を指定する文字列。A string that specifies how rows are to be filtered. 既定値は、null です。The default is null.

実装

次の例では、 FilterプロパティをDataViewと共に使用する方法を示します。The following example shows how to use the Filter property with a DataView. この例を実行するには、Windows フォームにコードを貼りPopulateDataViewAndFilter付け、フォームのコンストラクターまたLoadはイベント処理メソッドからを呼び出します。To run this example, paste the code into a Windows Form and call PopulateDataViewAndFilter from the form's constructor or Load event-handling method. フォームで名前空間System.XmlSystem.IO名前空間をインポートする必要があります。Your form should import the System.Xml and System.IO namespaces.

private void PopulateDataViewAndFilter()
{
    DataSet set1 = new DataSet();

    // Some xml data to populate the DataSet with.
    string musicXml =
        "<?xml version='1.0' encoding='UTF-8'?>" +
        "<music>" +
        "<recording><artist>Coldplay</artist><cd>X&amp;Y</cd></recording>" +
        "<recording><artist>Dave Matthews</artist><cd>Under the Table and Dreaming</cd></recording>" +
        "<recording><artist>Dave Matthews</artist><cd>Live at Red Rocks</cd></recording>" +
        "<recording><artist>Natalie Merchant</artist><cd>Tigerlily</cd></recording>" +
        "<recording><artist>U2</artist><cd>How to Dismantle an Atomic Bomb</cd></recording>" +
        "</music>";

    // Read the xml.
    StringReader reader = new StringReader(musicXml);
    set1.ReadXml(reader);

    // Get a DataView of the table contained in the dataset.
    DataTableCollection tables = set1.Tables;
    DataView view1 = new DataView(tables[0]);

    // Create a DataGridView control and add it to the form.
    DataGridView datagridview1 = new DataGridView();
    datagridview1.AutoGenerateColumns = true;
    this.Controls.Add(datagridview1);

    // Create a BindingSource and set its DataSource property to
    // the DataView.
    BindingSource source1 = new BindingSource();
    source1.DataSource = view1;

    // Set the data source for the DataGridView.
    datagridview1.DataSource = source1;

    //The Filter string can include Boolean expressions.
    source1.Filter = "artist = 'Dave Matthews' OR cd = 'Tigerlily'";
}
Private Sub PopulateDataViewAndFilter() 
    Dim set1 As New DataSet()
    
    ' Some xml data to populate the DataSet with.
    Dim musicXml As String = "<?xml version='1.0' encoding='UTF-8'?>" & _
        "<music>" & _
        "<recording><artist>Coldplay</artist><cd>X&amp;Y</cd></recording>" & _
        "<recording><artist>Dave Matthews</artist><cd>Under the Table and Dreaming</cd></recording>" & _
        "<recording><artist>Dave Matthews</artist><cd>Live at Red Rocks</cd></recording>" & _
        "<recording><artist>Natalie Merchant</artist><cd>Tigerlily</cd></recording>" & _
        "<recording><artist>U2</artist><cd>How to Dismantle an Atomic Bomb</cd></recording>" & _
        "</music>"
    
    ' Read the xml.
    Dim reader As New StringReader(musicXml)
    set1.ReadXml(reader)
    
    ' Get a DataView of the table contained in the dataset.
    Dim tables As DataTableCollection = set1.Tables
    Dim view1 As New DataView(tables(0))
    
    ' Create a DataGridView control and add it to the form.
    Dim datagridview1 As New DataGridView()
    datagridview1.AutoGenerateColumns = True
    Me.Controls.Add(datagridview1)
    
    ' Create a BindingSource and set its DataSource property to
    ' the DataView.
    Dim source1 As New BindingSource()
    source1.DataSource = view1
    
    ' Set the data source for the DataGridView.
    datagridview1.DataSource = source1
    
    ' The Filter string can include Boolean expressions.
    source1.Filter = "artist = 'Dave Matthews' OR cd = 'Tigerlily'"

End Sub

注釈

通常、複雑なデータバインディングのシナリオFilterで使用されます。プロパティを使用すると、 DataSourceのサブセットを表示できます。Typically used in complex data-binding scenarios, the Filter property allows you to view a subset of the DataSource. インターフェイスをIBindingListView実装する基になるリストだけがフィルター処理をサポートします。Only underlying lists that implement the IBindingListView interface support filtering.

Filterでないnull場合、 BindingSourceはこのプロパティを基になるリストに渡します。When Filter is not null, the BindingSource passes this property to the underlying list. オブジェクトの初期化中にこのプロパティを設定した場合、呼び出しは初期化が完了するまで遅延されます。If you set this property during object initialization, the call will be deferred until after initialization is complete.

フィルター値を作成するには、列の名前、演算子、およびフィルター処理する値を指定します。To form a filter value, specify the name of a column followed by an operator and a value to filter on. 許容されるフィルター構文は、基になるデータソースによって異なります。The accepted filter syntax depends on the underlying data source. 基になるデータソースDataSetが、 DataTable、またはDataViewの場合は、 DataColumn.Expressionプロパティについて説明されている構文を使用してブール式を指定できます。If the underlying data source is a DataSet, DataTable, or DataView, you can specify Boolean expressions using the syntax documented for the DataColumn.Expression property.

プロパティの値Filterは、 Countプロパティの値に影響します。The value of the Filter property affects the value of the Count property. また、 Filterデータソースが変更されると、値は保持されます。Additionally, the Filter value will persist when the data source changes. DataSourceフィルター処理を停止するにRemoveFilterは、メソッドを呼び出します。To stop filtering the DataSource, call the RemoveFilter method.

適用対象

こちらもご覧ください