Freigeben über


ObjectDataSource.FilterExpression Eigenschaft

Definition

Ruft einen Filterausdruck ab, der beim Aufruf der von der SelectMethod-Eigenschaft angegebenen Methode angewendet wird, oder legt diesen fest.

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

Eigenschaftswert

Eine Zeichenfolge, die einen Filterausdruck darstellt, der beim Abrufen von Daten mit der von der SelectMethod-Eigenschaft angegebenen Methode oder Funktion angewendet wird.

Ausnahmen

Die FilterExpression-Eigenschaft wurde festgelegt, und die Select()-Methode gibt nicht DataSet oder DataTable zurück.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie gefilterte Daten mithilfe eines ObjectDataSource Steuerelements zum Abrufen von Daten aus einem Geschäftsobjekt der mittleren Ebene und einem GridView Steuerelement zum Anzeigen der Ergebnisse angezeigt werden. Das ObjectDataSource -Steuerelement kann Daten nur filtern, wenn die Methode, die die Daten abruft, sie als - DataSet oder DataTable -Objekt abruft. Aus diesem Grund identifiziert die SelectMethod -Eigenschaft eine Geschäftsobjektmethode, die Daten als DataSetabruft.

Das Codebeispiel besteht aus einem TextBox Steuerelement, einem GridView Steuerelement, dem ObjectDataSource Steuerelement und einer Schaltfläche Senden . Standardmäßig wird mit TextBox dem Namen eines der Northwind Traders-Mitarbeiter aufgefüllt. Zeigt GridView Informationen über den Mitarbeiter an, der durch den Namen im TextBoxidentifiziert wird. Um Daten für einen anderen Mitarbeiter abzurufen, geben Sie den vollständigen Namen des Mitarbeiters in der TextBoxein, und klicken Sie dann auf die Schaltfläche Absenden .

Die FilterExpression -Eigenschaft gibt einen Ausdruck an, der verwendet wird, um die Daten zu filtern, die von der methode abgerufen werden, die von der SelectMethod -Eigenschaft angegeben wird. Es werden Parameterplatzhalter verwendet, die für die Parameter ausgewertet werden, die in der FilterParameters Auflistung enthalten sind. In diesem Beispiel wird der Parameterplatzhalter durch einfache Anführungszeichen begrenzt, da der Typ des Parameters ein Zeichenfolgentyp ist, der Leerzeichen enthalten kann. Wenn der Typ des Parameters ein numerischer Oder Datumstyp ist, sind begrenzungsgebundene Anführungszeichen nicht erforderlich.

Wichtig

Dieses Beispiel umfasst ein Textfeld, das Benutzereingaben akzeptiert, die ein potenzielles Sicherheitsrisiko darstellen. Standardmäßig stellen ASP.NET-Webseiten sicher, dass Benutzereingaben keine Skript- oder HTML-Elemente enthalten. Weitere Informationen finden Sie unter Übersicht über Skriptangriffe.

<%@ 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>

Das folgende Codebeispiel enthält ein Beispiel für ein Geschäftsobjekt der mittleren Ebene, das im vorherigen Codebeispiel verwendet wird. Das Codebeispiel besteht aus zwei grundlegenden Klassen:

  • Die EmployeeLogic -Klasse, die eine Klasse ist, die Geschäftslogik kapselt.

  • Die NorthwindEmployee -Klasse, bei der es sich um eine Modellklasse handelt, die nur die grundlegenden Funktionen enthält, die zum Laden und Beibehalten von Daten aus der Datenebene erforderlich sind.

Der Einfachheit halber erstellt die EmployeeLogic -Klasse einen statischen Satz von Daten, anstatt die Daten von einer Datenebene abzurufen. Es ist auch für dieses Beispiel hilfreich, da das Beispiel darauf angewiesen ist, dass Sie den vollständigen Namen eines Northwind Traders-Mitarbeiters angeben, um die Filterung zu veranschaulichen. Für ein vollständiges Funktionierendes Beispiel müssen Sie diese Klassen kompilieren und mit den bereitgestellten Web Forms-Codebeispielen verwenden.

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

Hinweise

Das ObjectDataSource -Steuerelement unterstützt das Filtern von Daten nur, wenn die Select -Methode ein - oder DataTable -DataSetObjekt zurückgibt.

Die Syntax, die für die FilterExpression -Eigenschaft verwendet wird, ist ein Formatausdruck im Zeichenfolgenformat. Die Syntax des Filterausdrucks ist dieselbe Syntax, die von der Expression -Eigenschaft akzeptiert wird. Wenn Sie der FilterParameters Auflistung Parameter hinzufügen, können Sie auch Platzhalter für Formatzeichenfolgen einschließen. Schließen Sie "{0}" beispielsweise in den Ausdruck ein, um Parameterwerte zu ersetzen. Die Platzhalter werden gemäß dem Index des Parameters in der FilterParameters Auflistung ersetzt.

Sie können Parameter in die FilterExpression -Eigenschaft einschließen. Wenn der Typ des Parameters ein Zeichenfolgen- oder Zeichentyp ist, schließen Sie den Parameter in einfache Anführungszeichen ein. Anführungszeichen sind nicht erforderlich, wenn der Parameter ein numerischer Typ ist.

Die FilterParameters Auflistung enthält die Parameter, die für die Platzhalter ausgewertet werden, die in der FilterExpression -Eigenschaft gefunden werden.

Die FilterExpression -Eigenschaft delegiert an die FilterExpression -Eigenschaft des ObjectDataSourceView -Objekts, das dem ObjectDataSource Steuerelement zugeordnet ist.

Hinweis

Sie sollten jeden Filterparameterwert überprüfen, den Sie vom Client erhalten. Die Laufzeit ersetzt einfach den Parameterwert in den Filterausdruck und wendet ihn auf das DataSet objekt oder DataTable an, das von der Select -Methode zurückgegeben wird. Wenn Sie die FilterExpression -Eigenschaft als Sicherheitsmaßnahme verwenden, um die Anzahl der zurückgegebenen Elemente zu begrenzen, müssen Sie die Parameterwerte überprüfen, bevor die Filterung erfolgt.

Gilt für:

Weitere Informationen