BindingSource.Filter Eigenschap
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Hiermee haalt u de expressie op die wordt gebruikt om te filteren welke rijen worden weergegeven.
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; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] set; }
public virtual string Filter { get; [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members of types used in the filter expression might be trimmed.")] set; }
member this.Filter : string with get, 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
Waarde van eigenschap
Een tekenreeks die aangeeft hoe rijen moeten worden gefilterd. De standaardwaarde is null.
Implementeringen
- Kenmerken
Voorbeelden
In het volgende voorbeeld ziet u hoe u de Filter eigenschap gebruikt met een DataView. Als u dit voorbeeld wilt uitvoeren, plakt u de code in een Windows Formulier en roept u PopulateDataViewAndFilter aan vanuit de constructor van het formulier of Load gebeurtenisafhandelingsmethode. Het formulier moet de System.Xml en System.IO naamruimten importeren.
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
Opmerkingen
Meestal gebruikt in complexe scenario's voor gegevensbinding, kunt u met de Filter eigenschap een subset van de DataSource. Alleen onderliggende lijsten die het filteren van de IBindingListView interface implementeren.
Wanneer Filter dit niet nullhet geval is, BindingSource wordt deze eigenschap doorgegeven aan de onderliggende lijst. Als u deze eigenschap instelt tijdens de object initialisatie, wordt de aanroep uitgesteld totdat de initialisatie is voltooid.
Als u een filterwaarde wilt maken, geeft u de naam van een kolom op, gevolgd door een operator en een waarde waarop u wilt filteren. De geaccepteerde filtersyntaxis is afhankelijk van de onderliggende gegevensbron. Als de onderliggende gegevensbron een DataSet, DataTableof DataView, is, kunt u Boole-expressies opgeven met behulp van de syntaxis die voor de DataColumn.Expression eigenschap is gedocumenteerd.
De waarde van de Filter eigenschap is van invloed op de waarde van de Count eigenschap. Bovendien blijft de Filter waarde behouden wanneer de gegevensbron wordt gewijzigd. Als u wilt stoppen met filteren DataSource, roept u de RemoveFilter methode aan.