ObjectDataSourceView.FilterExpression Propriété
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient ou définit une expression de filtrage qui est appliquée lorsque la méthode de l'objet métier qui est identifiée par la propriété SelectMethod est appelée.
public:
property System::String ^ FilterExpression { System::String ^ get(); void set(System::String ^ value); };public string FilterExpression { get; set; }member this.FilterExpression : string with get, setPublic Property FilterExpression As StringValeur de propriété
Une chaîne qui représente une expression de filtrage est appliquée lorsque les données sont récupérées à l'aide de la méthode de l'objet métier identifiée par la propriété SelectMethod.
Exceptions
La propriété FilterExpression a été définie et la méthode Select(DataSourceSelectArguments) ne retourne pas de DataSet.
Exemples
Cette section contient deux exemples de code. Le premier exemple de code montre comment afficher des données filtrées à l’aide d’un contrôle pour récupérer des données à partir d’un ObjectDataSource objet métier de niveau intermédiaire et d’un GridView contrôle pour afficher les résultats. Le deuxième exemple de code fournit un exemple d’objet métier de niveau intermédiaire utilisé dans le premier exemple de code.
L’exemple de code suivant montre comment afficher des données filtrées à l’aide d’un contrôle pour récupérer des données à partir d’un ObjectDataSource objet métier de niveau intermédiaire et d’un GridView contrôle pour afficher les résultats. Le ObjectDataSource contrôle peut filtrer les données uniquement lorsque la méthode qui récupère les données le récupère en tant qu’objet DataSet . Pour cette raison, la SelectMethod propriété identifie une méthode d’objet métier qui récupère les données en tant que DataSet.
L’exemple de code se compose d’un TextBoxcontrôle, ObjectDataSource d’un GridView contrôle et d’un bouton Envoyer. Par défaut, le TextBox fichier est rempli avec le nom de l’un des employés northwind Traders. Les GridView informations affichées sur l’employé identifié par le nom dans le TextBox. Pour récupérer des données sur un autre employé, dans le TextBox, entrez le nom complet de l’employé, puis cliquez sur le bouton Envoyer .
La FilterExpression propriété spécifie une expression utilisée pour filtrer les données récupérées par la SelectMethod propriété. Il utilise des espaces réservés de paramètres évalués aux paramètres contenus dans la FilterParameters collection. Dans cet exemple, l’espace réservé de paramètre est limité par des guillemets simples, car le type du paramètre est un type de chaîne qui peut contenir des espaces. Si le type du paramètre est un type numérique ou de date, les guillemets englobants ne sont pas obligatoires.
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %>
<%@ Page language="c#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
protected void ObjectDataSource1_Filtering(object sender, ObjectDataSourceFilteringEventArgs e)
{
if (Textbox1.Text == "")
{
e.ParameterValues.Clear();
e.ParameterValues.Add("FullName", "Nancy Davolio");
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>ObjectDataSource - C# Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<p>Show all users with the following name.</p>
<asp:textbox id="Textbox1" runat="server" text="Nancy Davolio" />
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1"
autogeneratecolumns="False">
<columns>
<asp:boundfield headertext="ID" datafield="EmpID" />
<asp:boundfield headertext="Name" datafield="FullName" />
<asp:boundfield headertext="Street Address" datafield="Address" />
</columns>
</asp:gridview>
<!-- Security Note: The ObjectDataSource uses a FormParameter,
Security Note: which does not perform validation of input from the client. -->
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployeesAsDataSet"
typename="Samples.AspNet.CS.EmployeeLogic"
filterexpression="FullName='{0}'" OnFiltering="ObjectDataSource1_Filtering">
<filterparameters>
<asp:formparameter name="FullName" formfield="Textbox1" defaultvalue="Nancy Davolio" />
</filterparameters>
</asp:objectdatasource>
<p><asp:button id="Button1" runat="server" text="Search" /></p>
</form>
</body>
</html>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB" Assembly="Samples.AspNet.VB" %>
<%@ Page language="vb" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Protected Sub ObjectDataSource1_Filtering(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.ObjectDataSourceFilteringEventArgs)
If Textbox1.Text = "" Then
e.ParameterValues.Clear()
e.ParameterValues.Add("FullName", "Nancy Davolio")
End If
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>ObjectDataSource - VB Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<p>Show all users with the following name.</p>
<asp:textbox id="Textbox1" runat="server" text="Nancy Davolio" />
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1"
autogeneratecolumns="False">
<columns>
<asp:boundfield headertext="ID" datafield="EmpID" />
<asp:boundfield headertext="Name" datafield="FullName" />
<asp:boundfield headertext="Street Address" datafield="Address" />
</columns>
</asp:gridview>
<!-- Security Note: The ObjectDataSource uses a FormParameter,
Security Note: which does not perform validation of input from the client. -->
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployeesAsDataSet"
typename="Samples.AspNet.VB.EmployeeLogic"
filterexpression="FullName='{0}'" OnFiltering="ObjectDataSource1_Filtering">
<filterparameters>
<asp:formparameter name="FullName" formfield="Textbox1" defaultvalue="Nancy Davolio" />
</filterparameters>
</asp:objectdatasource>
<p><asp:button id="Button1" runat="server" text="Search" /></p>
</form>
</body>
</html>
L’exemple de code suivant fournit un exemple d’objet métier de niveau intermédiaire que l’exemple de code précédent utilise. L’exemple de code se compose de deux classes de base :
Classe
EmployeeLogic, qui est une classe qui encapsule la logique métier.Classe
NorthwindEmployee, qui est une classe de modèle qui contient uniquement les fonctionnalités de base requises pour charger et conserver des données à partir du niveau de données.
Par souci de simplicité, la EmployeeLogic classe crée un jeu statique de données, plutôt que de récupérer les données à partir d’un niveau de données. Il est également utile pour cet exemple, car l’exemple s’appuie sur vous pour fournir le nom complet d’un employé Northwind Traders pour illustrer le filtrage.
Pour obtenir un exemple de travail complet, vous devez compiler et utiliser ces classes avec les exemples de code de page Web Forms fournis.
namespace Samples.AspNet.CS {
using System;
using System.Collections;
using System.Data;
using System.Web.UI.WebControls;
//
// EmployeeLogic is a stateless business object that encapsulates
// the operations you can perform on a NorthwindEmployee object.
//
public class EmployeeLogic {
// Returns a collection of NorthwindEmployee objects.
public static ICollection GetAllEmployees () {
ArrayList data = new ArrayList();
data.Add(new NorthwindEmployee(1,"Nancy","Davolio","507 - 20th Ave. E. Apt. 2A"));
data.Add(new NorthwindEmployee(2,"Andrew","Fuller","908 W. Capital Way"));
data.Add(new NorthwindEmployee(3,"Janet","Leverling","722 Moss Bay Blvd."));
data.Add(new NorthwindEmployee(4,"Margaret","Peacock","4110 Old Redmond Rd."));
data.Add(new NorthwindEmployee(5,"Steven","Buchanan","14 Garrett Hill"));
data.Add(new NorthwindEmployee(6,"Michael","Suyama","Coventry House Miner Rd."));
data.Add(new NorthwindEmployee(7,"Robert","King","Edgeham Hollow Winchester Way"));
return data;
}
public static NorthwindEmployee GetEmployee(object anID) {
ArrayList data = GetAllEmployees() as ArrayList;
int empID = Int32.Parse(anID.ToString());
return data[empID] as NorthwindEmployee;
}
//
// To support basic filtering, the employees cannot
// be returned as an array of objects, rather as a
// DataSet of the raw data values.
public static DataSet GetAllEmployeesAsDataSet () {
ICollection employees = GetAllEmployees();
DataSet ds = new DataSet("Table");
// Create the schema of the DataTable.
DataTable dt = new DataTable();
DataColumn dc;
dc = new DataColumn("EmpID", typeof(int)); dt.Columns.Add(dc);
dc = new DataColumn("FullName",typeof(string)); dt.Columns.Add(dc);
dc = new DataColumn("Address", typeof(string)); dt.Columns.Add(dc);
// Add rows to the DataTable.
DataRow row;
foreach (NorthwindEmployee ne in employees) {
row = dt.NewRow();
row["EmpID"] = ne.EmpID;
row["FullName"] = ne.FullName;
row["Address"] = ne.Address;
dt.Rows.Add(row);
}
// Add the complete DataTable to the DataSet.
ds.Tables.Add(dt);
return ds;
}
}
public class NorthwindEmployee {
public NorthwindEmployee (int anID,
string aFirstName,
string aLastName,
string anAddress) {
ID = anID;
firstName = aFirstName;
lastName = aLastName;
address = anAddress;
}
private object ID;
public string EmpID {
get { return ID.ToString(); }
}
private string lastName;
public string LastName {
get { return lastName; }
set { lastName = value; }
}
private string firstName;
public string FirstName {
get { return firstName; }
set { firstName = value; }
}
public string FullName {
get { return FirstName + " " + LastName; }
}
private string address;
public string Address {
get { return address; }
set { address = value; }
}
}
}
Imports System.Collections
Imports System.Data
Imports System.Web.UI.WebControls
Namespace Samples.AspNet.VB
'
' EmployeeLogic is a stateless business object that encapsulates
' the operations you can perform on a NorthwindEmployee object.
'
Public Class EmployeeLogic
' Returns a collection of NorthwindEmployee objects.
Public Shared Function GetAllEmployees() As ICollection
Dim data As New ArrayList()
data.Add(New NorthwindEmployee(1, "Nancy", "Davolio", "507 - 20th Ave. E. Apt. 2A"))
data.Add(New NorthwindEmployee(2, "Andrew", "Fuller", "908 W. Capital Way"))
data.Add(New NorthwindEmployee(3, "Janet", "Leverling", "722 Moss Bay Blvd."))
data.Add(New NorthwindEmployee(4, "Margaret", "Peacock", "4110 Old Redmond Rd."))
data.Add(New NorthwindEmployee(5, "Steven", "Buchanan", "14 Garrett Hill"))
data.Add(New NorthwindEmployee(6, "Michael", "Suyama", "Coventry House Miner Rd."))
data.Add(New NorthwindEmployee(7, "Robert", "King", "Edgeham Hollow Winchester Way"))
Return data
End Function 'GetAllEmployees
Public Shared Function GetEmployee(anID As Object) As NorthwindEmployee
Dim data As ArrayList = CType(GetAllEmployees(), ArrayList)
Dim empID As Integer = Int32.Parse(anID.ToString())
Return CType(data(empID),NorthwindEmployee)
End Function 'GetEmployee
' To support basic filtering, the employees cannot
' be returned as an array of objects, rather as a
' DataSet of the raw data values.
Public Shared Function GetAllEmployeesAsDataSet() As DataSet
Dim employees As ICollection = GetAllEmployees()
Dim ds As New DataSet("Table")
' Create the schema of the DataTable.
Dim dt As New DataTable()
Dim dc As DataColumn
dc = New DataColumn("EmpID", GetType(Integer))
dt.Columns.Add(dc)
dc = New DataColumn("FullName", GetType(String))
dt.Columns.Add(dc)
dc = New DataColumn("Address", GetType(String))
dt.Columns.Add(dc)
' Add rows to the DataTable.
Dim row As DataRow
Dim ne As NorthwindEmployee
For Each ne In employees
row = dt.NewRow()
row("EmpID") = ne.EmpID
row("FullName") = ne.FullName
row("Address") = ne.Address
dt.Rows.Add(row)
Next
' Add the complete DataTable to the DataSet.
ds.Tables.Add(dt)
Return ds
End Function 'GetAllEmployeesAsDataSet
End Class
Public Class NorthwindEmployee
Public Sub New(anID As Integer, aFirstName As String, aLastName As String, anAddress As String)
ID = anID
Me.aFirstName = aFirstName
Me.aLastName = aLastName
Me.aAddress = anAddress
End Sub
Private ID As Object
Public ReadOnly Property EmpID() As String
Get
Return ID.ToString()
End Get
End Property
Private aLastName As String
Public Property LastName() As String
Get
Return aLastName
End Get
Set
aLastName = value
End Set
End Property
Private aFirstName As String
Public Property FirstName() As String
Get
Return aFirstName
End Get
Set
aFirstName = value
End Set
End Property
Public ReadOnly Property FullName() As String
Get
Return FirstName & " " & LastName
End Get
End Property
Private aAddress As String
Public Property Address() As String
Get
Return aAddress
End Get
Set
aAddress = value
End Set
End Property
End Class
End Namespace
Remarques
Le ObjectDataSource contrôle prend en charge le filtrage des données uniquement lorsque la Select méthode retourne un DataSet, DataViewou DataTable un objet.
La syntaxe utilisée pour la FilterExpression propriété est une expression de style chaîne de format. La syntaxe d’expression de filtre est la même syntaxe que celle acceptée par la RowFilter propriété, car l’expression de filtre est appliquée à la RowFilter propriété de l’objet DataView retourné par l’exécution de la Select méthode. (Pour plus d’informations, consultez Expression.) Si vous ajoutez des paramètres à la FilterParameters collection, vous pouvez également inclure des espaces réservés de chaîne de format, par exemple "{0}", dans l’expression pour remplacer les valeurs de paramètre. Les espaces réservés sont remplacés en fonction de l’index du paramètre dans la FilterParameters collection.
Vous pouvez inclure des paramètres dans le FilterExpression. Si le type du paramètre est un type chaîne ou caractère, placez le paramètre entre guillemets simples. Les guillemets ne sont pas nécessaires si le paramètre est un type numérique. La FilterParameters collection contient les paramètres évalués pour les espaces réservés trouvés dans le FilterExpression.
La valeur de la propriété est stockée dans l’état FilterExpression d’affichage.
Important
Il est recommandé de valider toute valeur de paramètre de filtre que vous recevez du client. Le runtime remplace simplement la valeur du paramètre dans l’expression de filtre et l’applique à l’objet DataView retourné par la Select méthode. Si vous utilisez la FilterExpression propriété comme mesure de sécurité pour limiter le nombre d’éléments retournés, vous devez valider les valeurs de paramètre avant que le filtrage ne se produise.