ObjectDataSourceView.FilterExpression Vlastnost
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Získá nebo nastaví filtrovací výraz, který se použije při obchodní objekt metoda, která je identifikována SelectMethod vlastností je volána.
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 StringHodnota vlastnosti
Řetězec, který představuje filtrovací výraz použitý při načtení dat pomocí metody obchodního objektu identifikované vlastností SelectMethod .
Výjimky
Vlastnost FilterExpression byla nastavena a Select(DataSourceSelectArguments) metoda nevrací DataSethodnotu .
Příklady
Tato část obsahuje dva příklady kódu. První příklad kódu ukazuje, jak zobrazit filtrovaná data pomocí ObjectDataSource ovládacího prvku pro načtení dat z obchodního objektu střední vrstvy a GridView ovládacího prvku pro zobrazení výsledků. Druhý příklad kódu poskytuje příklad obchodního objektu střední vrstvy, který se používá v prvním příkladu kódu.
Následující příklad kódu ukazuje, jak zobrazit filtrovaná data pomocí ObjectDataSource ovládacího prvku pro načtení dat z obchodního objektu GridView střední vrstvy a ovládacího prvku pro zobrazení výsledků. Ovládací ObjectDataSource prvek může filtrovat data pouze v případě, že metoda, která načte data načítá jako DataSet objekt. Z tohoto důvodu vlastnost identifikuje metodu obchodního objektu, SelectMethod která načítá data jako DataSet.
Příklad kódu se skládá z TextBoxGridView ovládacího prvku, ObjectDataSource ovládacího prvku a tlačítka Odeslat. Ve výchozím nastavení TextBox je vyplněný názvem jednoho zaměstnance Northwind Traders. Zobrazí GridView informace o zaměstnanci, který je identifikován jménem v souboru TextBox. Pokud chcete načíst data o jiném zaměstnanci, TextBoxzadejte do pole celé jméno zaměstnance a klikněte na tlačítko Odeslat .
Vlastnost FilterExpression určuje výraz, který slouží k filtrování dat načtených SelectMethod vlastností. Používá zástupné symboly parametrů, které se vyhodnocují na parametry obsažené v kolekci FilterParameters . V tomto příkladu je zástupný symbol parametru ohraničen jednoduchými uvozovkami, protože typ parametru je typ řetězce, který může obsahovat mezery. Pokud je typ parametru číselný nebo datový typ, nejsou povinné uvozovky.
<%@ 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>
Následující příklad kódu poskytuje příklad obchodního objektu střední vrstvy, který používá předchozí příklad kódu. Příklad kódu se skládá ze dvou základních tříd:
Třída
EmployeeLogic, což je třída, která zapouzdřuje obchodní logiku.Třída
NorthwindEmployee, což je třída modelu, která obsahuje pouze základní funkce, které se vyžadují k načtení a uchování dat z datové vrstvy.
Pro zjednodušení EmployeeLogic třída vytvoří statickou sadu dat, nikoli načítání dat z datové vrstvy. Je také užitečné pro tento příklad, protože ukázka spoléhá na vás, abyste zadali úplný název zaměstnance Northwind Traders, který demonstruje filtrování.
Pro úplný pracovní příklad je nutné zkompilovat a používat tyto třídy s příklady kódu stránky Web Forms, které jsou k dispozici.
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
Poznámky
Ovládací ObjectDataSource prvek podporuje filtrování dat pouze v Select případě, že metoda vrátí DataSet, DataViewnebo DataTable objekt.
Syntaxe, která se používá pro FilterExpression vlastnost, je formát výrazu stylu řetězce. Syntaxe výrazu filtru je stejná syntaxe, která je přijata vlastností RowFilter , protože výraz filtru se použije na RowFilter vlastnost DataView objektu, který je vrácen z provádění Select metody. (Další informace najdete v tématu Expression.) Pokud do FilterParameters kolekce přidáte parametry, můžete do výrazu zahrnout také zástupné symboly řetězců formátu, "{0}"které nahradí hodnoty parametrů. Zástupné symboly se nahradí podle indexu parametru v kolekci FilterParameters .
Parametry můžete zahrnout do .FilterExpression Pokud je typ parametru řetězec nebo typ znaku, uzavřete parametr do jednoduchých uvozovek. Uvozovky nejsou potřeba, pokud je parametr číselným typem. Kolekce FilterParameters obsahuje parametry, které se vyhodnocují pro zástupné symboly nalezené v souboru FilterExpression.
Hodnota FilterExpression vlastnosti je uložena ve stavu zobrazení.
Důležité
Doporučujeme ověřit hodnotu parametru filtru, kterou obdržíte od klienta. Modul runtime jednoduše nahradí hodnotu parametru výrazem filtru a použije ji na DataView objekt vrácený metodou Select . Pokud vlastnost používáte FilterExpression jako bezpečnostní míru k omezení počtu vrácených položek, musíte před filtrováním ověřit hodnoty parametrů.