BindingSource.Filter Eigenschaft

Definition

Ruft den Ausdruck ab, mit dem die anzuzeigenden Zeilen gefiltert werden, oder legt diesen fest.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

Eigenschaftswert

String

Eine Zeichenfolge, die angibt, wie Zeilen gefiltert werden sollen.A string that specifies how rows are to be filtered. Der Standardwert lautet null.The default is null.

Implementiert

Beispiele

Im folgenden Beispiel wird gezeigt, wie die Filter-Eigenschaft mit einem DataViewverwendet wird.The following example shows how to use the Filter property with a DataView. Fügen Sie zum Ausführen dieses Beispiels den Code in ein Windows Form ein, und nennen Sie PopulateDataViewAndFilter aus dem Konstruktor des Formulars oder Load Ereignis Behandlungsmethode.To run this example, paste the code into a Windows Form and call PopulateDataViewAndFilter from the form's constructor or Load event-handling method. Das Formular sollte die System.Xml-und System.IO-Namespaces importieren.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

Hinweise

Die Filter-Eigenschaft ermöglicht in der Regel die Verwendung in komplexen Daten Bindungs Szenarios, eine Teilmenge der DataSourceanzuzeigen.Typically used in complex data-binding scenarios, the Filter property allows you to view a subset of the DataSource. Nur zugrunde liegende Listen, die die IBindingListView Schnittstelle implementieren, unterstützen das Filtern.Only underlying lists that implement the IBindingListView interface support filtering.

Wenn Filter nicht nullist, übergibt der BindingSource diese Eigenschaft an die zugrunde liegende Liste.When Filter is not null, the BindingSource passes this property to the underlying list. Wenn Sie diese Eigenschaft während der Objekt Initialisierung festlegen, wird der-Rückruf verzögert, bis die Initialisierung beendet ist.If you set this property during object initialization, the call will be deferred until after initialization is complete.

Um einen Filter Wert zu erstellen, geben Sie den Namen einer Spalte an, gefolgt von einem Operator und einem Wert, nach dem gefiltert werden soll.To form a filter value, specify the name of a column followed by an operator and a value to filter on. Die akzeptierte Filter Syntax hängt von der zugrunde liegenden Datenquelle ab.The accepted filter syntax depends on the underlying data source. Wenn die zugrunde liegende Datenquelle eine DataSet, DataTableoder DataViewist, können Sie boolesche Ausdrücke mithilfe der Syntax angeben, die für die DataColumn.Expression-Eigenschaft dokumentiert ist.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.

Der Wert der Filter-Eigenschaft wirkt sich auf den Wert der Count-Eigenschaft aus.The value of the Filter property affects the value of the Count property. Außerdem wird der Filter Wert beibehalten, wenn sich die Datenquelle ändert.Additionally, the Filter value will persist when the data source changes. Um das Filtern der DataSourceanzuhalten, wenden Sie die RemoveFilter-Methode an.To stop filtering the DataSource, call the RemoveFilter method.

Gilt für:

Siehe auch