BindingSource.Filter Свойство

Определение

Возвращает или задает выражение, используемое для фильтрации просматриваемых строк.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

Значение свойства

Строка, задающая способ фильтрации строк.A string that specifies how rows are to be filtered. Значение по умолчанию: null.The default is null.

Реализации

Примеры

В следующем примере показано, как использовать свойство Filter с DataView.The following example shows how to use the Filter property with a DataView. Чтобы выполнить этот пример, вставьте код в форму Windows Forms и вызовите PopulateDataViewAndFilter из конструктора формы или Load метода обработки событий.To run this example, paste the code into a Windows Form and call PopulateDataViewAndFilter from the form's constructor or Load event-handling method. Форма должна импортировать System.Xml и System.IO пространства имен.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

Комментарии

Как правило, в сложных сценариях привязки данных свойство Filter позволяет просматривать подмножество DataSource.Typically used in complex data-binding scenarios, the Filter property allows you to view a subset of the DataSource. Только базовые списки, реализующие интерфейс IBindingListView, поддерживают фильтрацию.Only underlying lists that implement the IBindingListView interface support filtering.

Если Filter не null, BindingSource передает это свойство в базовый список.When Filter is not null, the BindingSource passes this property to the underlying list. Если задать это свойство во время инициализации объекта, вызов будет отложен до завершения инициализации.If you set this property during object initialization, the call will be deferred until after initialization is complete.

Чтобы сформировать значение фильтра, укажите имя столбца, за которым следует оператор и значение для фильтрации.To form a filter value, specify the name of a column followed by an operator and a value to filter on. Принятый синтаксис фильтра зависит от базового источника данных.The accepted filter syntax depends on the underlying data source. Если базовый источник данных является DataSet, DataTableили DataView, можно указать логические выражения, используя синтаксис, задокументированный для свойства DataColumn.Expression.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.

Значение свойства Filter влияет на значение свойства Count.The value of the Filter property affects the value of the Count property. Кроме того, значение Filter будет сохраняться при изменении источника данных.Additionally, the Filter value will persist when the data source changes. Чтобы прерывать фильтрацию DataSource, вызовите метод RemoveFilter.To stop filtering the DataSource, call the RemoveFilter method.

Применяется к

Дополнительно