BindingSource.Filter Właściwość

Definicja

Przestrzeń nazw:

System.Windows.Forms

Zestaw:

System.Windows.Forms.dll

Źródło:

BindingSource.cs

Pobiera lub ustawia wyrażenie używane do filtrowania, które wiersze są wyświetlane.

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

public virtual string? Filter { get; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] 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

Wartość właściwości

String

Ciąg określający sposób filtrowania wierszy. Wartość domyślna to null.

Implementuje

Filter

Atrybuty

RequiresUnreferencedCodeAttribute

Przykłady

W poniższym przykładzie pokazano, jak używać Filter właściwości z elementem DataView. Aby uruchomić ten przykład, wklej kod do formularza systemu Windows i wywołaj PopulateDataViewAndFilter go z konstruktora formularza lub Load metody obsługi zdarzeń. Formularz powinien importować System.Xml przestrzenie nazw i 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

Uwagi

Zazwyczaj używane w złożonych scenariuszach Filter powiązania danych właściwość umożliwia wyświetlenie podzestawu elementu DataSource. Tylko listy bazowe, które implementują filtrowanie interfejsu IBindingListView .

Jeśli Filter parametr nie nullma wartości , BindingSource właściwość przekazuje tę właściwość do listy bazowej. Jeśli ustawisz tę właściwość podczas inicjowania obiektu, wywołanie zostanie odroczone do momentu ukończenia inicjowania.

Aby utworzyć wartość filtru, określ nazwę kolumny, po której następuje operator i wartość do filtrowania. Zaakceptowana składnia filtru zależy od bazowego źródła danych. Jeśli bazowe źródło danych to DataSet, DataTablelub DataView, można określić wyrażenia logiczne przy użyciu składni udokumentowanej DataColumn.Expression dla właściwości .

Wartość Filter właściwości wpływa na wartość Count właściwości. Filter Ponadto wartość będzie utrwalana po zmianie źródła danych. Aby zatrzymać filtrowanie DataSourcemetody , wywołaj metodę RemoveFilter .

Zobacz też

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