ObjectDataSource.FilterExpression Свойство

Определение

Возвращает или задает выражение фильтрации, применяемое при вызове метода, заданного свойством SelectMethod.Gets or sets a filtering expression that is applied when the method that is specified 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

Значение свойства

Строка, представляющая выражение фильтрации, которое применяется при извлечении данных с помощью метода или функции, заданных свойством SelectMethod.A string that represents a filtering expression that is applied when data is retrieved by using the method or function identified by the SelectMethod property.

Исключения

Значение свойства FilterExpression задано, а метод Select() не возвращает значение DataSet или DataTable.The FilterExpression property was set and the Select() method does not return a DataSet or DataTable.

Примеры

В следующем примере кода показано, как отобразить отфильтрованные данные с помощью элемента управления ObjectDataSource для получения данных из бизнес-объекта среднего уровня и элемента управления GridView для отображения результатов.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. Элемент управления ObjectDataSource может фильтровать данные только в том случае, если метод, извлекающий данные, извлекает его как объект DataSet или DataTable.The ObjectDataSource control can filter data only when the method that retrieves the data retrieves it as a DataSet or DataTable object. По этой причине свойство SelectMethod определяет метод бизнес-объекта, извлекающий данные как DataSet.For this reason, the SelectMethod property identifies a business object method that retrieves data as a DataSet.

Пример кода состоит из элемента управления TextBox, GridView элемента управления, ObjectDataSource элемента управления и кнопки отправки .The code example consists of a TextBox control, a GridView control, the ObjectDataSource control, and a Submit button. По умолчанию TextBox заполняется именем одного из сотрудников компании Northwind Traders.By default, the TextBox is populated with the name of one of the Northwind Traders employees. GridView отображает сведения о сотруднике, идентифицируемые по имени в TextBox.The GridView displays information about the employee that is identified by the name in the TextBox. Чтобы получить данные другого сотрудника, введите полное имя сотрудника в TextBoxи нажмите кнопку Submit (отправить ).To retrieve data on another employee, enter the full name of the employee in the TextBox, and then click the Submit button.

Свойство FilterExpression указывает выражение, используемое для фильтрации данных, получаемых методом, указанным свойством SelectMethod.The FilterExpression property specifies an expression that is used to filter the data that is retrieved by the method that is specified by the SelectMethod property. Он использует заполнители параметров, которые оцениваются для параметров, содержащихся в коллекции FilterParameters.It uses parameter placeholders that are evaluated to the parameters that are contained in the FilterParameters collection. В этом примере заполнитель параметра ограничен одинарными кавычками, так как тип параметра является строковым типом, который может содержать пробелы.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. Если тип параметра является числовым или типом даты, ограничивающие кавычки не требуются.If the type of the parameter is a numeric or date type, bounding quotation marks are not required.

Важно!

В этом примере имеется текстовое поле, принимающее вводимые пользователем данные, что является потенциальной угрозой безопасности.This example has a text box that accepts user input, which is a potential security threat. По умолчанию данные, вводимые пользователем на веб-страницах ASP.NET, проверяются на наличие скриптов и HTML-элементов.By default, ASP.NET Web pages validate that user input does not include script or HTML elements. Дополнительные сведения см. в разделе Общие сведения об использовании сценариев.For more information, see Script Exploits Overview.

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

В следующем примере кода приведен пример бизнес-объекта среднего уровня, используемого в предыдущем примере кода.The following code example provides an example of a middle-tier business object that the preceding code example uses. Пример кода состоит из двух базовых классов:The code example consists of two basic classes:

  • Класс EmployeeLogic, представляющий собой класс, инкапсулирующий бизнес-логику.The EmployeeLogic class, which is a class that encapsulates business logic.

  • Класс NorthwindEmployee, который является классом модели и содержит только базовые функциональные возможности, необходимые для загрузки и сохранения данных на уровне данных.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.

Для простоты класс EmployeeLogic создает статический набор данных, а не извлекает данные из уровня данных.For simplicity, the EmployeeLogic class creates a static set of data, rather than retrieving the data from a data tier. Это также полезно в этом примере, так как в примере используется полное имя сотрудника Northwind Trader для демонстрации фильтрации.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. Для выполнения полного рабочего примера необходимо скомпилировать и использовать эти классы с предоставленными примерами кода веб-форм.For a complete working example, you must compile and use these classes with the Web Forms 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

Комментарии

Элемент управления ObjectDataSource поддерживает фильтрацию данных только в том случае, если метод Select возвращает объект DataSet или DataTable.The ObjectDataSource control supports filtering data only when the Select method returns a DataSet or DataTable object.

Синтаксис, используемый для свойства FilterExpression, — это выражение в стиле строки форматирования.The syntax that is used for the FilterExpression property is a format string-style expression. Синтаксис критерия фильтра — это тот же синтаксис, который принимается свойством Expression.The filter expression syntax is the same syntax that is accepted by the Expression property. Если вы добавляете параметры в коллекцию FilterParameters, можно также включить заполнители форматирования строк.If you add parameters to the FilterParameters collection, you can also include format string placeholders. Например, включите в выражение "{0}", чтобы заменить значения параметров.For example, include "{0}" in the expression to substitute for parameter values. Заполнители заменяются в соответствии с индексом параметра в коллекции FilterParameters.The placeholders are replaced according to the index of the parameter in the FilterParameters collection.

Параметры можно включить в свойство FilterExpression.You can include parameters in the FilterExpression property. Если тип параметра является строкой или символьным типом, заключите параметр в одинарные кавычки.If the type of the parameter is a string or character type, enclose the parameter in single quotation marks. Если параметр имеет числовой тип, кавычки не требуются.Quotation marks are not required if the parameter is a numeric type.

Коллекция FilterParameters содержит параметры, которые оцениваются для заполнителей, найденных в свойстве FilterExpression.The FilterParameters collection contains the parameters that are evaluated for the placeholders that are found in the FilterExpression property.

Свойство FilterExpression делегирует свойство FilterExpression объекта ObjectDataSourceView, связанного с элементом управления ObjectDataSource.The FilterExpression property delegates to the FilterExpression property of the ObjectDataSourceView object that is associated with the ObjectDataSource control.

Примечание

Необходимо проверить любое значение параметра фильтра, полученное от клиента.You should validate any filter parameter value that you receive from the client. Среда выполнения просто подставляет значение параметра в критерий фильтра и применяет его к DataSet или DataTable объекту, возвращаемому методом Select.The runtime simply substitutes the parameter value into the filter expression and applies it to the DataSet or DataTable object that is returned by the Select method. Если вы используете свойство FilterExpression в качестве меры безопасности для ограничения числа возвращаемых элементов, необходимо проверить значения параметров до того, как будет выполняться фильтрация.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.

Применяется к

Дополнительно