BindingSource.Filter Propiedad

Definición

Obtiene o establece la expresión utilizada para filtrar las filas que se deben mostrar.

public:
 virtual property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };
public virtual string Filter { get; set; }
public virtual string? Filter { get; set; }
member this.Filter : string with get, set
Public Overridable Property Filter As String

Valor de propiedad

Cadena que especifica cómo se van a filtrar las filas. De manera predeterminada, es null.

Implementaciones

Ejemplos

En el ejemplo siguiente se muestra cómo usar la Filter propiedad con .DataView Para ejecutar este ejemplo, pegue el código en un formulario Windows Forms y llame PopulateDataViewAndFilter desde el constructor o Load el método de control de eventos del formulario. El formulario debe importar los System.Xml espacios de nombres y 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

Comentarios

Normalmente se usa en escenarios complejos de enlace de datos, la Filter propiedad permite ver un subconjunto de .DataSource Solo las listas subyacentes que implementan la interfaz admiten el IBindingListView filtrado.

Cuando Filter no nulles , BindingSource pasa esta propiedad a la lista subyacente. Si establece esta propiedad durante la inicialización del objeto, la llamada se aplazará hasta que se complete la inicialización.

Para formar un valor de filtro, especifique el nombre de una columna seguida de un operador y un valor para filtrar. La sintaxis de filtro aceptada depende del origen de datos subyacente. Si el origen de datos subyacente es , DataSetDataTableo DataView, puede especificar expresiones booleanas mediante la sintaxis documentada para la DataColumn.Expression propiedad .

El valor de la Filter propiedad afecta al valor de la Count propiedad . Además, el Filter valor se conservará cuando cambie el origen de datos. Para detener el filtrado de DataSource, llame al RemoveFilter método .

Se aplica a

Consulte también