BindingSource.Filter Vlastnost

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zdroj:

BindingSource.cs

Získá nebo nastaví výraz použitý k filtrování zobrazených řádků.

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

Hodnota vlastnosti

String

Řetězec, který určuje, jak mají být řádky filtrovány. Výchozí hodnota je null.

Implementuje

Filter

Atributy

RequiresUnreferencedCodeAttribute

Příklady

Následující příklad ukazuje, jak použít Filter vlastnost s .DataView Tento příklad spustíte tak, že kód vložíte do formuláře Windows a zavoláte PopulateDataViewAndFilter ho z konstruktoru formuláře nebo Load metody zpracování událostí. Formulář by měl importovat obory System.Xml názvů a System.IO obory názvů.

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

Poznámky

Obvykle se používá ve scénářích složitých datových vazeb, Filter vlastnost umožňuje zobrazit podmnožinu objektu DataSource. Filtrování podporují pouze podkladové seznamy, které implementují IBindingListView rozhraní.

Pokud Filter není null, BindingSource předá tuto vlastnost podkladovému seznamu. Pokud tuto vlastnost nastavíte během inicializace objektů, bude volání odloženo do dokončení inicializace.

Chcete-li vytvořit hodnotu filtru, zadejte název sloupce následovaný operátorem a hodnotou, podle které chcete filtrovat. Přijatá syntaxe filtru závisí na podkladovém zdroji dat. Pokud je podkladovým DataSetzdrojem dat nebo DataTableDataView, můžete zadat logické výrazy pomocí syntaxe zdokumentované pro DataColumn.Expression vlastnost.

Hodnota Filter vlastnosti ovlivňuje hodnotu Count vlastnosti. Hodnota se navíc zachová, Filter když se zdroj dat změní. Pokud chcete filtrování DataSourcezastavit, zavolejte metodu RemoveFilter .

Viz také

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