BindingSource.Filter Propriété

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

BindingSource.cs

Obtient ou définit l’expression utilisée pour filtrer les lignes qui sont consultées.

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

Valeur de propriété

String

Chaîne qui spécifie la façon dont les lignes doivent être filtrées. La valeur par défaut est null.

Implémente

Filter

Attributs

RequiresUnreferencedCodeAttribute

Exemples

L’exemple suivant montre comment utiliser la Filter propriété avec un DataView. Pour exécuter cet exemple, collez le code dans un Windows Form et appelez PopulateDataViewAndFilter à partir du constructeur ou Load de la méthode de gestion des événements du formulaire. Votre formulaire doit importer les espaces de noms et System.IO les System.Xml espaces de noms.

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

Remarques

Généralement utilisée dans des scénarios complexes de liaison de données, la Filter propriété vous permet d’afficher un sous-ensemble de l’objet DataSource. Seules les listes sous-jacentes qui implémentent l’interface prennent en charge le IBindingListView filtrage.

Quand Filter ce n’est pas nullle cas, la BindingSource propriété passe à la liste sous-jacente. Si vous définissez cette propriété pendant l’initialisation de l’objet, l’appel est différé jusqu’à la fin de l’initialisation.

Pour former une valeur de filtre, spécifiez le nom d’une colonne suivie d’un opérateur et d’une valeur à filtrer. La syntaxe de filtre acceptée dépend de la source de données sous-jacente. Si la source de données sous-jacente est un DataSet, DataTableou DataView, vous pouvez spécifier des expressions booléennes à l’aide de la syntaxe documentée pour la DataColumn.Expression propriété.

La valeur de la Filter propriété affecte la valeur de la Count propriété. En outre, la Filter valeur persiste lorsque la source de données change. Pour arrêter le DataSourcefiltrage, appelez la RemoveFilter méthode.

Voir aussi

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