ObjectDataSourceFilteringEventArgs ObjectDataSourceFilteringEventArgs ObjectDataSourceFilteringEventArgs ObjectDataSourceFilteringEventArgs Class

Definition

Stellt Daten für das Filtering-Ereignis des ObjectDataSource-Steuerelements bereit.Provides data for the Filtering event of the ObjectDataSource control.

public ref class ObjectDataSourceFilteringEventArgs : System::ComponentModel::CancelEventArgs
public class ObjectDataSourceFilteringEventArgs : System.ComponentModel.CancelEventArgs
type ObjectDataSourceFilteringEventArgs = class
    inherit CancelEventArgs
Public Class ObjectDataSourceFilteringEventArgs
Inherits CancelEventArgs
Vererbung
ObjectDataSourceFilteringEventArgsObjectDataSourceFilteringEventArgsObjectDataSourceFilteringEventArgsObjectDataSourceFilteringEventArgs

Beispiele

Dieser Abschnitt enthält zwei Codebeispiele.This section contains two code examples. Im ersten Codebeispiel wird veranschaulicht, wie gefilterte Daten mit einem ObjectDataSource -Steuerelement zum Abrufen von Daten aus einem Geschäftsobjekt der mittleren Ebene angezeigt werden GridView und anschließend ein-Steuerelement verwendet wird, um die Ergebnisse anzuzeigen.The first code example demonstrates how to display filtered data by using an ObjectDataSource control to retrieve data from a middle-tier business object, and then using a GridView control to display the results. Das zweite Codebeispiel enthält ein Beispiel für ein Geschäftsobjekt der mittleren Ebene, das im ersten Codebeispiel verwendet wird.The second code example provides an example of a middle-tier business object that is used by the first code example.

Im folgenden Codebeispiel wird veranschaulicht, wie gefilterte Daten mit einem ObjectDataSource -Steuerelement zum Abrufen von Daten aus einem Geschäftsobjekt der mittleren Ebene angezeigt werden GridView und anschließend ein-Steuerelement verwendet wird, um die Ergebnisse anzuzeigen.The following code example demonstrates how to display filtered data by using an ObjectDataSource control to retrieve data from a middle-tier business object, and then using a GridView control to display the results. Das ObjectDataSource -Steuerelement kann Daten nur filtern, wenn die Methode, die die Daten abruft, DataSet es DataTable als-oder-Objekt abruft.The ObjectDataSource control can filter data only when the method that retrieves the data retrieves it as a DataSet or DataTable object. Aus diesem Grund identifiziert die SelectMethod -Eigenschaft eine Geschäftsobjekt Methode, die Daten als ein DataSet -oder DataTable -Objekt abruft.For this reason, the SelectMethod property identifies a business object method that retrieves data as a DataSet or DataTable object.

Das Codebeispiel besteht aus einem TextBox -Steuerelement GridView , einem- ObjectDataSource Steuerelement, dem-Steuerelement und der Schaltfläche " senden ".The code example consists of a TextBox control, a GridView control, the ObjectDataSource control, and a Submit button. Standardmäßig wird das TextBox Steuerelement mit dem Namen eines Mitarbeiters bei Northwind Traders aufgefüllt.By default, the TextBox control is populated with the name of one of the employees at Northwind Traders. Das GridView -Steuerelement zeigt Informationen zum Mitarbeiter an, der durch den Namen in TextBoxder identifiziert wird.The GridView control displays information about the employee who is identified by the name in the TextBox. Wenn Sie Daten für einen anderen Mitarbeiter abrufen möchten TextBox , geben Sie im Steuerelement den vollständigen Namen des Mitarbeiters ein, und klicken Sie dann auf die Schaltfläche senden .To retrieve data for another employee, in the TextBox control, type the full name of the employee, and then click the Submit button.

Die FilterExpression -Eigenschaft gibt einen Ausdruck an, der verwendet wird, um die Daten zu filtern, die von der Methode abgerufen SelectMethod werden, die von der-Eigenschaft angegeben wird.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. Dabei werden Parameter Platzhalter verwendet, die für die in der FilterParameters Auflistung enthaltenen Parameter ausgewertet werden.It uses parameter placeholders that are evaluated to the parameters that are contained in the FilterParameters collection. In diesem Beispiel wird der Parameter Platzhalter in einfache Anführungszeichen (') eingeschlossen, da der Typ des Parameters ein Zeichen Folgentyp ist, der möglicherweise Leerzeichen enthält.In this example, the parameter placeholder is enclosed by single quotation marks (') because the type of the parameter is a string type that might contain spaces. Wenn der Typ des Parameters numerisch oder Date ist, sind keine Anführungszeichen erforderlich.If the type of the parameter is numeric or date, quotation marks are not required. Die FilterParameters -Auflistung enthält einen Parameter, FormParameter ein-Objekt, das an TextBox das-Steuerelement gebunden ist.The FilterParameters collection contains one parameter, a FormParameter object that is bound to the TextBox control.

Wenn im TextBox -Steuerelement kein Name angegeben ist, wird der ParameterValues Auflistung ein neuer Parameter hinzugefügt, sodass die Suche erfolgreich ist.If no name is specified in the TextBox control, a new parameter is added to the ParameterValues collection so that the search is successful.

Wichtig

Dieses Beispiel enthält ein Textfeld, das Benutzereingaben akzeptiert. Dies ist eine potenzielle Sicherheitsbedrohung.This example contains a text box that accepts user input, which is a potential security threat. Standardmäßig stellen ASP.NET-Webseiten sicher, dass Benutzereingaben keine Skript- oder HTML-Elemente enthalten.By default, ASP.NET Web pages validate that user input does not include script or HTML elements. Weitere Informationen finden Sie unter Übersicht über Skriptangriffe.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>

Das folgende Codebeispiel enthält ein Beispiel für ein Geschäftsobjekt der mittleren Ebene, das im vorangehenden Codebeispiel verwendet wird.The following code example provides an example of a middle-tier business object that the preceding code example uses. Das Codebeispiel besteht aus zwei grundlegenden Klassen EmployeeLogic : NorthwindEmployeeund.The code example consists of two basic classes: EmployeeLogic and NorthwindEmployee. Die EmployeeLogic -Klasse kapselt die Geschäftslogik NorthwindEmployee , und die-Klasse ist eine Modell Klasse, die nur die grundlegenden Funktionen enthält, die zum Laden und Speichern von Daten aus der Datenebene erforderlich sind.The EmployeeLogic class encapsulates business logic and the NorthwindEmployee class is a model class that contains only the basic functionality that is required to load and persist data from the data tier. Der Einfachheit halber erstellt EmployeeLogic die-Klasse einen statischen Satz von Daten, anstatt die Daten von einer Datenebene abzurufen.For simplicity, the EmployeeLogic class creates a static set of data, rather than retrieving the data from a data tier. Ein umfassendes, funktionierendes Beispiel ist die Kompilierung und Verwendung dieser Klassen mit den Web Forms Codebeispielen, die bereitgestellt werden.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 'EmployeeLogic 


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 'NorthwindEmployee
End Namespace

Hinweise

Die ObjectDataSourceFilteringEventArgs -Klasse wird verwendet, um Daten an Filtering den-Ereignishandler ObjectDataSource des-Steuer Elements zu übergeben.The ObjectDataSourceFilteringEventArgs class is used to pass data to the Filtering event handler of the ObjectDataSource control. Die ParameterValues -Eigenschaft ermöglicht den Zugriff auf die Filter Parameterwerte, bevor der Filter Vorgang durchgeführt wird.The ParameterValues property provides access to the filter parameter values before the filtering operation is performed. Sie können die Select -Methode ObjectDataSourceFilteringEventArgs abbrechen, indem Cancel Sie die-Eigenschaft truevon auf festlegen.You can cancel the Select method by setting the Cancel property of the ObjectDataSourceFilteringEventArgs to true.

Konstruktoren

ObjectDataSourceFilteringEventArgs(IOrderedDictionary) ObjectDataSourceFilteringEventArgs(IOrderedDictionary) ObjectDataSourceFilteringEventArgs(IOrderedDictionary) ObjectDataSourceFilteringEventArgs(IOrderedDictionary)

Initialisiert eine neue Instanz der ObjectDataSourceFilteringEventArgs-Klasse unter Verwendung des angegebenen Objekts.Initializes a new instance of the ObjectDataSourceFilteringEventArgs class by using the specified object.

Eigenschaften

Cancel Cancel Cancel Cancel

Ruft einen Wert ab, der angibt, ob das Ereignis abgebrochen werden soll, oder legt diesen fest.Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
ParameterValues ParameterValues ParameterValues ParameterValues

Ruft eine IOrderedDictionary-Schnittstelle ab, die den Zugriff auf die Parameter-Objekte der ObjectDataSource-Klasse ermöglicht.Gets an IOrderedDictionary interface that provides access to the Parameter objects of the ObjectDataSource class.

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für:

Siehe auch