Udostępnij za pośrednictwem


ObjectDataSourceView.FilterExpression Właściwość

Definicja

Pobiera lub ustawia wyrażenie filtrowania, które jest stosowane, gdy wywoływana jest metoda obiektu biznesowego SelectMethod identyfikowana przez właściwość.

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 reprezentujący wyrażenie filtrowania stosowane podczas pobierania danych przy użyciu metody obiektu biznesowego SelectMethod identyfikowanej przez właściwość.

Wyjątki

Właściwość została ustawiona FilterExpression , a Select(DataSourceSelectArguments) metoda nie zwraca wartości DataSet.

Przykłady

Ten rozdział zawiera dwa przykłady kodu. Pierwszy przykład kodu przedstawia sposób wyświetlania filtrowanych danych przy użyciu ObjectDataSource kontrolki w celu pobrania danych z obiektu biznesowego warstwy środkowej i GridView kontrolki w celu wyświetlenia wyników. Drugi przykład kodu zawiera przykład obiektu biznesowego warstwy środkowej, który jest używany w pierwszym przykładzie kodu.

Poniższy przykład kodu przedstawia sposób wyświetlania przefiltrowanych danych przy użyciu ObjectDataSource kontrolki w celu pobrania danych z obiektu biznesowego warstwy środkowej i GridView kontrolki w celu wyświetlenia wyników. Kontrolka ObjectDataSource może filtrować dane tylko wtedy, gdy metoda pobierająca dane pobiera je jako DataSet obiekt. Z tego powodu SelectMethod właściwość identyfikuje metodę obiektu biznesowego, która pobiera dane jako DataSet.

Przykład kodu składa się z TextBoxkontrolki , GridView kontrolki, kontrolki ObjectDataSource i przycisku Prześlij . Domyślnie element TextBox jest wypełniany nazwą jednego z pracowników firmy Northwind Traders. Wyświetla GridView informacje o pracowniku, który jest identyfikowany przez nazwę w elemecie TextBox. Aby pobrać dane innego pracownika, w pliku TextBoxwprowadź pełną nazwę pracownika, a następnie kliknij przycisk Prześlij .

Właściwość FilterExpression określa wyrażenie używane do filtrowania danych pobieranych przez SelectMethod właściwość. Używa symboli zastępczych parametrów, które są oceniane dla parametrów zawartych w kolekcji FilterParameters . W tym przykładzie symbol zastępczy parametru jest powiązany z pojedynczymi cudzysłowami, ponieważ typ parametru jest typem ciągu, który może zawierać spacje. Jeśli typ parametru jest typem liczbowym lub typem daty, znaki cudzysłowu nie są wymagane.

<%@ 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 używanego w poprzednim przykładzie kodu. Przykładowy kod składa się z dwóch podstawowych klas:

  • Klasa EmployeeLogic , która jest klasą, która hermetyzuje logikę biznesową.

  • Klasa NorthwindEmployee , która jest klasą modelu, która zawiera tylko podstawowe funkcje wymagane do załadowania i utrwalania danych z warstwy danych.

Dla uproszczenia EmployeeLogic klasa tworzy statyczny zestaw danych zamiast pobierać dane z warstwy danych. Jest to również przydatne w tym przykładzie, ponieważ przykład opiera się na podaniu pełnej nazwy pracownika firmy Northwind Traders w celu zademonstrowania filtrowania.

Aby uzyskać pełny przykład pracy, należy skompilować i użyć tych klas z podanymi przykładami kodu strony Web Forms.

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

Kontrolka ObjectDataSource obsługuje filtrowanie danych tylko wtedy, gdy Select metoda zwraca DataSetobiekt , DataViewlub DataTable .

Składnia używana dla FilterExpression właściwości to wyrażenie w stylu ciągu formatu. 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 zwracanego z wykonywania Select metody. (Aby uzyskać więcej informacji, zobacz Expression.) Jeśli dodasz parametry do FilterParameters kolekcji, możesz również uwzględnić symbole zastępcze ciągu formatu, na przykład "{0}", w wyrażeniu, aby zastąpić wartości parametrów. Symbole zastępcze są zastępowane zgodnie z indeksem parametru w kolekcji FilterParameters .

Parametry można uwzględnić w elemecie FilterExpression. Jeśli typ parametru jest ciągiem lub typem znaku, należy ująć parametr w pojedynczy cudzysłów. Znaki cudzysłowu nie są potrzebne, jeśli parametr jest typem liczbowym. Kolekcja FilterParameters zawiera parametry, które są oceniane dla symboli zastępczych znalezionych w obiekcie FilterExpression.

Wartość FilterExpression właściwości jest przechowywana w stanie widoku.

Ważne

Zaleca się zweryfikowanie dowolnej wartości parametru filtru otrzymanej od klienta. Środowisko uruchomieniowe po prostu zastępuje wartość parametru w wyrażeniu filtru i stosuje je do DataView obiektu zwróconego przez metodę Select . Jeśli używasz FilterExpression właściwości jako miary zabezpieczeń w celu ograniczenia liczby zwracanych elementów, musisz zweryfikować wartości parametrów przed rozpoczęciem filtrowania.

Dotyczy

Zobacz też