BindingSource.Filter Eigenschaft

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Quelle:

BindingSource.cs

Ruft den Ausdruck ab, mit dem gefiltert wird, welche Zeilen angezeigt werden, oder legt diesen fest.

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

Eigenschaftswert

String

Eine Zeichenfolge, die angibt, wie Zeilen gefiltert werden sollen. Der Standardwert lautet null.

Implementiert

Filter

Attribute

RequiresUnreferencedCodeAttribute

Beispiele

Das folgende Beispiel zeigt, wie die Filter Eigenschaft mit einer DataView. Zum Ausführen dieses Beispiels fügen Sie den Code in ein Windows Form-Formular ein, und rufen Sie den Aufruf PopulateDataViewAndFilter aus dem Konstruktor oder Load der Ereignisbehandlungsmethode des Formulars auf. Ihr Formular sollte die System.Xml Namespaces System.IO importieren.

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

Hinweise

In der Regel in komplexen Datenbindungsszenarien verwendet, ermöglicht ihnen die Filter Eigenschaft das Anzeigen einer Teilmenge der DataSource. Nur zugrunde liegende Listen, die die IBindingListView Schnittstellenunterstützungsfilterung implementieren.

Ist Filter dies nicht nullder Fall, übergibt die BindingSource Eigenschaft an die zugrunde liegende Liste. Wenn Sie diese Eigenschaft während der Objektinitialisierung festlegen, wird der Aufruf zurückgestellt, bis die Initialisierung abgeschlossen ist.

Um einen Filterwert zu bilden, geben Sie den Namen einer Spalte gefolgt von einem Operator und einem Wert an, nach dem gefiltert werden soll. Die akzeptierte Filtersyntax hängt von der zugrunde liegenden Datenquelle ab. Wenn es sich bei der zugrunde liegenden Datenquelle um eine DataSetoder DataTableDataViewmehrere boolesche Ausdrücke handelt, können Sie boolesche Ausdrücke mithilfe der für die DataColumn.Expression Eigenschaft dokumentierten Syntax angeben.

Der Wert der Filter Eigenschaft wirkt sich auf den Wert der Count Eigenschaft aus. Darüber hinaus wird der Filter Wert beibehalten, wenn sich die Datenquelle ändert. Rufen Sie die RemoveFilter Methode auf, um die DataSourceFilterung zu beenden.

Weitere Informationen

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