ObjectDataSourceView.FilterExpression Właściwość

Definicja

Pobiera lub ustawia wyrażenie filtrowania stosowane, gdy wywoływana jest metoda obiektu biznesowego, która jest identyfikowana przez SelectMethod Właściwość.Gets or sets a filtering expression that is applied when the business object method that is identified by the SelectMethod property is called.

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

Wartość właściwości

String

Ciąg, który reprezentuje wyrażenie filtrowania stosowane podczas pobierania danych przy użyciu metody obiektu biznesowego identyfikowanej przez SelectMethod Właściwość.A string that represents a filtering expression applied when data is retrieved using the business object method identified by the SelectMethod property.

Wyjątki

FilterExpressionWłaściwość została ustawiona, a Select(DataSourceSelectArguments) Metoda nie zwraca elementu DataSet .The FilterExpression property was set and the Select(DataSourceSelectArguments) method does not return a DataSet.

Przykłady

Ten rozdział zawiera dwa przykłady kodu.This section contains two code examples. Pierwszy przykład kodu demonstruje sposób wyświetlania filtrowanych danych przy użyciu ObjectDataSource kontrolki do pobierania danych z obiektu biznesowego warstwy środkowej i GridView kontrolki do wyświetlania wyników.The first code example demonstrates how to display filtered data using an ObjectDataSource control to retrieve data from a middle-tier business object and a GridView control to display the results. Drugi przykład kodu zawiera przykładowy obiekt biznesowy warstwy środkowej, który jest używany w pierwszym przykładzie kodu.The second code example provides an example of the middle-tier business object that is used in the first code example.

Poniższy przykład kodu ilustruje sposób wyświetlania filtrowanych danych przy użyciu ObjectDataSource kontrolki do pobierania danych z obiektu biznesowego warstwy środkowej i GridView kontrolki do wyświetlania wyników.The following code example demonstrates how to display filtered data using an ObjectDataSource control to retrieve data from a middle-tier business object and a GridView control to display the results. ObjectDataSourceKontrolka może filtrować dane tylko wtedy, gdy metoda pobierająca dane pobiera ją jako DataSet obiekt.The ObjectDataSource control can filter data only when the method that retrieves the data retrieves it as a DataSet object. Z tego powodu SelectMethod Właściwość identyfikuje metodę obiektu biznesowego, która pobiera dane jako DataSet .For this reason, the SelectMethod property identifies a business object method that retrieves data as a DataSet.

Przykład kodu składa się z TextBox , GridView kontrolki, ObjectDataSource kontrolki i przycisku przesyłania .The code example consists of a TextBox, a GridView control, the ObjectDataSource control, and a Submit button. Domyślnie TextBox jest wypełniony nazwą jednego z pracowników firmy Northwind Traders.By default, the TextBox is populated with the name of one of the Northwind Traders employees. GridViewWyświetla informacje o pracowniku identyfikowane przez nazwę w TextBox .The GridView displays information about the employee that is identified by the name in the TextBox. Aby pobrać dane z innego pracownika, w programie TextBox wprowadź pełną nazwę pracownika, a następnie kliknij przycisk Prześlij .To retrieve data on another employee, in the TextBox, enter the full name of the employee, and then click the Submit button.

FilterExpressionWłaściwość określa wyrażenie, które jest używane do filtrowania danych pobieranych przez SelectMethod Właściwość.The FilterExpression property specifies an expression that is used to filter the data that is retrieved by the SelectMethod property. Używa ona symboli zastępczych parametrów, które są oceniane do parametrów, które są zawarte w FilterParameters kolekcji.It uses parameter placeholders that are evaluated to the parameters that are contained in the FilterParameters collection. W tym przykładzie symbol zastępczy parametru jest ograniczony przez znaki pojedynczego cudzysłowu, ponieważ typ parametru jest ciągiem, który może zawierać spacje.In this example, the parameter placeholder is bounded by single quotation marks because the type of the parameter is a string type that might contain spaces. Jeśli typ parametru jest liczbą lub typem daty, powiązane cudzysłowy nie są wymagane.If the type of the parameter is a numeric or date type, bounding quotation marks are not required.

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

Poniższy przykład kodu zawiera przykład obiektu biznesowego warstwy środkowej, który jest użyty w poprzednim przykładzie kodu.The following code example provides an example of a middle-tier business object that the preceding code example uses. Przykład kodu składa się z dwóch podstawowych klas:The code example consists of two basic classes:

  • EmployeeLogicKlasa, która jest klasą, która hermetyzuje logikę biznesową.The EmployeeLogic class, which is a class that encapsulates business logic.

  • NorthwindEmployeeKlasa, która jest klasą modelu, która zawiera tylko podstawowe funkcje wymagane do ładowania i utrwalania danych z warstwy danych.The NorthwindEmployee class, which is a model class that contains only the basic functionality that is required to load and persist data from the data tier.

Dla uproszczenia EmployeeLogic Klasa tworzy statyczny zestaw danych, zamiast pobierać dane z warstwy danych.For simplicity, the EmployeeLogic class creates a static set of data, rather than retrieving the data from a data tier. Jest on również przydatny w tym przykładzie, ponieważ przykład polega na podaniu pełnej nazwy pracownika Northwind Traders do zademonstrowania filtrowania.It is also helpful for this example, because the sample relies on you to provide the full name of a Northwind Traders employee to demonstrate filtering.

Aby zapoznać się z kompletnym przykładem pracy, należy skompilować i użyć tych klas ze szczegółowymi przykładami kodu strony formularzy sieci Web.For a complete working example, you must compile and use these classes with the Web Forms page code examples that are provided.

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

Uwagi

ObjectDataSourceKontrolka obsługuje filtrowanie danych tylko wtedy Select , gdy metoda zwraca DataSet DataView obiekt,, lub DataTable .The ObjectDataSource control supports filtering data only when the Select method returns a DataSet, DataView, or DataTable object.

Składnia, która jest używana dla FilterExpression właściwości jest wyrażeniem typu ciąg-styl.The syntax that is used for the FilterExpression property is a format string-style expression. Składnia wyrażenia filtru jest tą samą składnią, która jest akceptowana przez RowFilter Właściwość, ponieważ wyrażenie filtru jest stosowane do RowFilter właściwości DataView obiektu, który jest zwracany przez wykonywanie Select metody.The filter expression syntax is the same syntax that is accepted by the RowFilter property because the filter expression is applied to the RowFilter property of the DataView object that is returned from executing the Select method. (Aby uzyskać więcej informacji, zobacz Expression .) W przypadku dodawania parametrów do FilterParameters kolekcji można także uwzględnić symbole zastępcze ciągów formatowania, na przykład "{0}" , w wyrażeniu, aby zastąpić wartości parametrów.(For more information, see Expression.) If you add parameters to the FilterParameters collection, you can also include format string placeholders, for example "{0}", in the expression to substitute for parameter values. Symbole zastępcze są zamieniane według indeksu parametru w FilterParameters kolekcji.The placeholders are replaced according to the index of the parameter in the FilterParameters collection.

Parametry można dołączać FilterExpression .You can include parameters in the FilterExpression. Jeśli typ parametru jest ciągiem lub znakiem, należy ująć parametr w znaki pojedynczego cudzysłowu.If the type of the parameter is a string or character type, enclose the parameter in single quotation marks. Znaki cudzysłowu nie są zbędne, jeśli parametr jest typu liczbowego.Quotation marks are not needed if the parameter is a numeric type. FilterParametersKolekcja zawiera parametry, które są oceniane dla symboli zastępczych znalezionych w elemencie FilterExpression .The FilterParameters collection contains the parameters that are evaluated for the placeholders found in the FilterExpression.

Wartość FilterExpression właściwości jest przechowywana w stanie widoku.The value of the FilterExpression property is stored in view state.

Ważne

Zalecane jest zweryfikowanie wszelkich wartości parametrów filtru otrzymywanych od klienta.It is recommended that you validate any filter parameter value that you receive from the client. Środowisko uruchomieniowe po prostu zastępuje wartość parametru do wyrażenia filtru i stosuje je do DataView obiektu, który jest zwracany przez Select metodę.The runtime simply substitutes the parameter value into the filter expression and applies it to the DataView object that is returned by the Select method. Jeśli używasz FilterExpression właściwości jako miary zabezpieczeń, aby ograniczyć liczbę zwracanych elementów, należy sprawdzić poprawność wartości parametrów przed przystąpieniem do filtrowania.If you are using the FilterExpression property as a security measure to limit the number of items that are returned, you must validate the parameter values before the filtering occurs.

Dotyczy

Zobacz też