BindingSource.Filter Egenskap

public:
 virtual property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };

public virtual string Filter { get; set; }

public virtual string? Filter { get; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] set; }

public virtual string Filter { get; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] set; }

member this.Filter : string with 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

Public Overridable Property Filter As String

Egenskapsvärde

En sträng som anger hur rader ska filtreras. Standardvärdet är null.

Implementeringar

Attribut

RequiresUnreferencedCodeAttribute

Exempel

I följande exempel visas hur du använder egenskapen Filter med en DataView. Om du vill köra det här exemplet klistrar du in koden i ett Windows formulär och anropar PopulateDataViewAndFilter från formulärets konstruktor eller Load händelsehanteringsmetod. Formuläret ska importera namnrymderna System.Xml och System.IO .

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&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&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

Kommentarer

Egenskapen används vanligtvis i komplexa databindningsscenarier och Filter gör att du kan visa en delmängd av DataSource. Endast underliggande listor som implementerar IBindingListView gränssnittet stöder filtrering.

När Filter är inte nullskickas den BindingSource här egenskapen till den underliggande listan. Om du anger den här egenskapen under objektinitiering skjuts anropet upp tills initieringen har slutförts.

Om du vill skapa ett filtervärde anger du namnet på en kolumn följt av en operator och ett värde att filtrera på. Den godkända filtersyntaxen beror på den underliggande datakällan. Om den underliggande datakällan är en DataSet, DataTable, eller DataView, kan du ange booleska uttryck med hjälp av den syntax som dokumenteras för DataColumn.Expression egenskapen.

Värdet för Filter egenskapen påverkar värdet för Count egenskapen. Dessutom bevaras Filter värdet när datakällan ändras. Om du vill sluta filtrera DataSourceRemoveFilter anropa du metoden.

Se även

• DataSource
• List
• Sort
• RemoveFilter()
• IsSorted