ObjectDataSourceView.FilterExpression Eigenschaft

Referenz

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft einen Filterausdruck ab, der beim Aufruf der von der SelectMethod-Eigenschaft angegebenen Geschäftsobjektmethode 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

String

Eine Zeichenfolge, die einen Filterausdruck darstellt, der beim Datenabruf unter Verwendung der von der SelectMethod-Eigenschaft angegebenen Geschäftsobjektmethode angewendet wird.

Ausnahmen

NotSupportedException

Die FilterExpression-Eigenschaft wurde festgelegt, und die Select(DataSourceSelectArguments)-Methode gibt kein DataSet zurück.

Beispiele

Dieser Abschnitt enthält zwei Codebeispiele. Das erste Codebeispiel veranschaulicht, wie gefilterte Daten mithilfe eines ObjectDataSource Steuerelements zum Abrufen von Daten aus einem Geschäftsobjekt auf mittlerer Ebene und einem GridView Steuerelement zum Anzeigen der Ergebnisse angezeigt werden. Im zweiten Codebeispiel wird ein Beispiel für das Geschäftsobjekt der mittleren Ebene bereitgestellt, das im ersten Codebeispiel verwendet wird.

Im folgenden Codebeispiel wird veranschaulicht, wie gefilterte Daten mithilfe eines ObjectDataSource Steuerelements zum Abrufen von Daten aus einem Geschäftsobjekt auf mittlerer 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, als DataSet Objekt abruft. Aus diesem Grund identifiziert die SelectMethod Eigenschaft eine Geschäftsobjektmethode, die Daten als eine DataSetabruft.

Das Codebeispiel besteht aus einem TextBoxSteuerelement, einem GridView Steuerelement, dem ObjectDataSource Steuerelement und einer Schaltfläche zum Senden . Standardmäßig wird der TextBox Name eines der Northwind Traders-Mitarbeiter aufgefüllt. Die GridView Anzeige von Informationen über den Mitarbeiter, der durch den Namen in der TextBox. Wenn Sie Daten für einen anderen Mitarbeiter abrufen möchten, geben Sie im TextBoxFeld "Senden" den vollständigen Namen des Mitarbeiters ein, und klicken Sie dann auf die Schaltfläche "Senden ".

Die FilterExpression Eigenschaft gibt einen Ausdruck an, der zum Filtern der von der SelectMethod Eigenschaft abgerufenen Daten verwendet wird. Es verwendet Parameterplatzhalter, die für die Parameter ausgewertet werden, die in der FilterParameters Auflistung enthalten sind. In diesem Beispiel wird der Parameterplatzhalter durch einzelne Anführungszeichen gebunden, 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.

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

Im folgenden Codebeispiel wird ein Beispiel für ein Geschäftsobjekt der mittleren Ebene bereitgestellt, 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, die eine Modellklasse ist, die nur die grundlegende Funktionalität enthält, die zum Laden und Speichern von Daten aus der Datenebene erforderlich ist.

Die Klasse erstellt eine EmployeeLogic statische Datenmenge, anstatt die Daten aus einer Datenebene abzurufen. Es ist auch hilfreich für dieses Beispiel, da das Beispiel auf Sie angewiesen ist, den vollständigen Namen eines Northwind Traders-Mitarbeiters bereitzustellen, um die Filterung zu veranschaulichen.

Für ein vollständiges Arbeitsbeispiel müssen Sie diese Klassen kompilieren und mit den Web Forms Seitencodebeispielen verwenden, die bereitgestellt werden.

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 , DataViewoder DataSet DataTable ein Objekt zurückgibt.

Die Syntax, die für die FilterExpression Eigenschaft verwendet wird, ist ein Formatausdruck im Zeichenfolgenstil. Die Syntax des Filterausdrucks ist dieselbe Syntax, die von der RowFilter Eigenschaft akzeptiert wird, da der Filterausdruck auf die RowFilter Eigenschaft des DataView Objekts angewendet wird, das von der Ausführung der Select Methode zurückgegeben wird. (Weitere Informationen finden Sie unter Expression.) Wenn Sie der FilterParameters Auflistung Parameter hinzufügen, können Sie auch Formatzeichenfolgenplatzhalter einschließen, z "{0}". B. im Ausdruck, um Parameterwerte zu ersetzen. Die Platzhalter werden gemäß dem Index des Parameters in der FilterParameters Auflistung ersetzt.

Sie können Parameter in die FilterExpression. Wenn der Typ des Parameters ein Zeichenfolgen- oder Zeichentyp ist, schließen Sie den Parameter in einfache Anführungszeichen ein. Anführungszeichen werden nicht benötigt, 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.

Der Wert der FilterExpression Eigenschaft wird im Ansichtszustand gespeichert.

Wichtig

Es wird empfohlen, jeden Filterparameterwert zu überprüfen, den Sie vom Client erhalten. Die Laufzeit ersetzt einfach den Parameterwert in den Filterausdruck und wendet ihn auf das DataView Objekt 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 einzuschränken, müssen Sie die Parameterwerte überprüfen, bevor die Filterung auftritt.

Gilt für

Siehe auch

FilterParameters

Freigeben über