BindingSource.Filter Свойство

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Возвращает или задает выражение, используемое для фильтрации просматриваемых строк.

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

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

String

Строка, задающая способ фильтрации строк. Значение по умолчанию — null.

Реализации

Filter

Примеры

В следующем примере показано, как использовать Filter свойство с DataView. Чтобы запустить этот пример, вставьте код в форму Windows Forms и вызовите PopulateDataViewAndFilter из конструктора формы или Load метода обработки событий. Форма должна импортировать System.Xml пространства имен и System.IO .

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

Комментарии

Обычно используется в сложных сценариях привязки Filter данных, свойство позволяет просматривать подмножество DataSource. Фильтрацию поддерживают только базовые списки IBindingListView , реализующие интерфейс .

Если Filter значение не nullравно , BindingSource объект передает это свойство в базовый список. Если задать это свойство во время инициализации объекта, вызов будет отложен до завершения инициализации.

Чтобы сформировать значение фильтра, укажите имя столбца, за которым следует оператор и значение для фильтрации. Допустимый синтаксис фильтра зависит от базового источника данных. Если базовым DataSetисточником данных является , DataTableили DataView, можно указать логические выражения с помощью синтаксиса, описанного для DataColumn.Expression свойства .

Значение Filter свойства влияет на значение Count свойства. Кроме того, Filter значение будет сохраняться при изменении источника данных. Чтобы остановить фильтрацию DataSource, вызовите RemoveFilter метод .

См. также раздел

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