.NET Framework Class Library ObjectDataSourceEventArgs Class
Inheritance Hierarchy
Namespace:
System.Web.UI.WebControls
Assembly:
System.Web (in System.Web.dll)
Syntax
Public Class ObjectDataSourceEventArgs _
Inherits EventArgs
public class ObjectDataSourceEventArgs : EventArgs
public ref class ObjectDataSourceEventArgs : public EventArgs
type ObjectDataSourceEventArgs =
class
inherit EventArgs
end
The ObjectDataSourceEventArgs type exposes the following members.
Constructors
Properties
Methods
Remarks
The ObjectDataSourceEventArgs class is used in the OnObjectCreating and OnObjectCreated methods to provide access to the business object instance before any data operations that are using the ObjectDataSource control and business object are performed. The business object is set and accessed using the ObjectInstance property. By adding an event handler delegate to handle the ObjectCreating event, you can create an instance of the business object in custom code instead of the ObjectDataSource performing the instantiation. This is useful when you want a non-default instance of your business object or to call a non-default constructor to create the instance; the ObjectDataSource always calls the default constructor to create an instance of the business object it works with. You can also add an event handler delegate to handle the ObjectCreated event, which enables you to access any publicly exposed members of the business object to perform any additional initialization or work. The OnObjectCreating and OnObjectCreated methods are not called by the ObjectDataSource control, if the business object method that performs the data operations is static. The ObjectDataSource control exposes many events that you can handle to work with the underlying business object at various times in its lifecycle. The following table lists the events and the associated EventArgs classes and event handler delegates.
Examples
This section contains two code examples. The first code example demonstrates how to use an ObjectDataSource control with a business object and a GridView control to retrieve and display information. The second code example provides the example basic business object that the first code example uses. The following code example demonstrates how to use an ObjectDataSource control with a business object and a GridView control to retrieve and display information. In this example, as in many real-world scenarios, it might not be possible nor appropriate to use a default instance of the business object with the ObjectDataSource control. In this example, the ObjectDataSource cannot successfully call the default constructor because it will throw an exception. In some cases, the default constructor might be protected and in others it might not initialize the business object to a desired state. Whatever the reason, you can create an instance of the business object yourself and set the instance to the ObjectInstance property of the ObjectDataSourceEventArgs object that is passed to the handler. This is the business object instance that the ObjectDataSource will use to perform its work.
<%@ Import namespace="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">
Private Sub NorthwindLogicCreating(sender As Object, e As ObjectDataSourceEventArgs)
' Create an instance of the business object using a non-default constructor.
Dim eLogic As EmployeeLogic = New EmployeeLogic("Not created by the default constructor!")
' Set the ObjectInstance property so that the ObjectDataSource uses the created instance.
e.ObjectInstance = eLogic
End Sub ' NorthwindLogicCreating
</script>
<html >
<head>
<title>ObjectDataSource - VB Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1">
</asp:gridview>
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployees"
onobjectcreating="NorthwindLogicCreating"
typename="Samples.AspNet.VB.EmployeeLogic" >
</asp:objectdatasource>
</form>
</body>
</html>
<%@ Import namespace="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">
private void NorthwindLogicCreating(object sender, ObjectDataSourceEventArgs e)
{
// Create an instance of the business object using a non-default constructor.
EmployeeLogic eLogic = new EmployeeLogic("Not created by the default constructor!");
// Set the ObjectInstance property so that the ObjectDataSource uses the created instance.
e.ObjectInstance = eLogic;
}
</script>
<html >
<head>
<title>ObjectDataSource - C# Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1">
</asp:gridview>
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployees"
onobjectcreating="NorthwindLogicCreating"
typename="Samples.AspNet.CS.EmployeeLogic" >
</asp:objectdatasource>
</form>
</body>
</html>
The following code example demonstrates the example basic business object that the preceding code example uses.
Imports System
Imports System.Collections
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace Samples.AspNet.VB
Public Class EmployeeLogic
Public Sub New()
Throw New NotSupportedException("Initialize data.")
End Sub 'New
Public Sub New(ByVal data As String)
_data = data
End Sub 'New
Private _data As String
' Returns a collection of NorthwindEmployee objects.
Public Function GetAllEmployees() As ICollection
Dim al As New ArrayList()
al.Add(_data)
Return al
End Function 'GetAllEmployees
End Class 'EmployeeLogic
End Namespace ' Samples.AspNet.VB
namespace Samples.AspNet.CS {
using System;
using System.Collections;
using System.Web.UI;
using System.Web.UI.WebControls;
public class EmployeeLogic {
public EmployeeLogic() {
throw new NotSupportedException("Initialize data.");
}
public EmployeeLogic(string data) {
_data = data;
}
private string _data;
// Returns a collection of NorthwindEmployee objects.
public ICollection GetAllEmployees () {
ArrayList al = new ArrayList();
al.Add(_data);
return al;
}
}
}
Version Information
.NET FrameworkSupported in: 4, 3.5, 3.0, 2.0
Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
|
Bibliothèque de classes .NET Framework ObjectDataSourceEventArgs, classe
Hiérarchie d'héritage
Espace de noms :
System.Web.UI.WebControls
Assembly :
System.Web (dans System.Web.dll)
Syntaxe
Public Class ObjectDataSourceEventArgs _
Inherits EventArgs
public class ObjectDataSourceEventArgs : EventArgs
public ref class ObjectDataSourceEventArgs : public EventArgs
type ObjectDataSourceEventArgs =
class
inherit EventArgs
end
Le type ObjectDataSourceEventArgs expose les membres suivants.
Constructeurs
Propriétés
Méthodes
Notes
La classe ObjectDataSourceEventArgs est utilisée dans les méthodes OnObjectCreating et OnObjectCreated pour fournir un accès à l'instance de l'objet métier avant que toute opération de données utilisant le contrôle ObjectDataSource et l'objet métier ne soit effectuée. L'objet métier est défini et son accès s'effectue à l'aide de la propriété ObjectInstance. En ajoutant un délégué de gestionnaire d'événements pour gérer l'événement ObjectCreating, vous pouvez créer une instance de l'objet métier dans un code personnalisé au lieu de ObjectDataSource qui exécute l'instanciation. Ceci est utile lorsque vous souhaitez une instance non définie par défaut de votre objet métier ou souhaitez appeler un constructeur non défini par défaut pour créer l'instance ; ObjectDataSource appelle toujours le constructeur par défaut pour créer une instance de l'objet métier avec lequel elle travaille. Vous pouvez également ajouter un délégué de gestionnaire d'événements pour gérer l'événement ObjectCreated qui vous permet d'accéder à tous les membres de l'objet métier exposés publiquement pour exécuter toute initialisation ou travail supplémentaire. Les méthodes OnObjectCreating et OnObjectCreated ne sont pas appelées par le contrôle ObjectDataSource, si la méthode de l'objet métier qui exécute les opérations de données est static. Le contrôle ObjectDataSource expose de nombreux événements que vous pouvez gérer pour utiliser l'objet métier sous-jacent à divers stades de son cycle de vie. Le tableau suivant répertorie les événements et les classes EventArgs et délégués de gestionnaires d'événements associés.
Exemples
Cette section comprend deux exemples de code. Le premier exemple de code illustre comment utiliser un contrôle ObjectDataSource avec un objet métier et un contrôle GridView pour récupérer et afficher des informations. Le deuxième exemple de code fournit l'exemple d'objet métier de base utilisé par le premier exemple de code. L'exemple de code suivant illustre comment utiliser un contrôle ObjectDataSource avec un objet métier et un contrôle GridView pour récupérer et afficher des informations. Dans cet exemple, comme dans beaucoup de scénarios réels, il est probable qu'il ne soit ni possible, ni approprié d'utiliser une instance de l'objet métier par défaut avec le contrôle ObjectDataSource. Dans cet exemple, ObjectDataSource ne peut pas joindre le constructeur par défaut, parce qu'il lèvera une exception. Dans certains cas, le constructeur par défaut peut être protégé et dans d'autres, il se peut qu'il n'initialise pas l'objet métier à l'état désiré. Quelle que soit la raison, vous pouvez vous-même créer une instance de l'objet métier et affecter à l'instance la propriété ObjectInstance de l'objet ObjectDataSourceEventArgs qui est passé au gestionnaire. Ceci est l'instance de l'objet métier que ObjectDataSource utilisera pour exécuter son travail.
<%@ Import namespace="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">
Private Sub NorthwindLogicCreating(sender As Object, e As ObjectDataSourceEventArgs)
' Create an instance of the business object using a non-default constructor.
Dim eLogic As EmployeeLogic = New EmployeeLogic("Not created by the default constructor!")
' Set the ObjectInstance property so that the ObjectDataSource uses the created instance.
e.ObjectInstance = eLogic
End Sub ' NorthwindLogicCreating
</script>
<html >
<head>
<title>ObjectDataSource - VB Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1">
</asp:gridview>
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployees"
onobjectcreating="NorthwindLogicCreating"
typename="Samples.AspNet.VB.EmployeeLogic" >
</asp:objectdatasource>
</form>
</body>
</html>
<%@ Import namespace="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">
private void NorthwindLogicCreating(object sender, ObjectDataSourceEventArgs e)
{
// Create an instance of the business object using a non-default constructor.
EmployeeLogic eLogic = new EmployeeLogic("Not created by the default constructor!");
// Set the ObjectInstance property so that the ObjectDataSource uses the created instance.
e.ObjectInstance = eLogic;
}
</script>
<html >
<head>
<title>ObjectDataSource - C# Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<asp:gridview
id="GridView1"
runat="server"
datasourceid="ObjectDataSource1">
</asp:gridview>
<asp:objectdatasource
id="ObjectDataSource1"
runat="server"
selectmethod="GetAllEmployees"
onobjectcreating="NorthwindLogicCreating"
typename="Samples.AspNet.CS.EmployeeLogic" >
</asp:objectdatasource>
</form>
</body>
</html>
L'exemple de code suivant illustre l'exemple d'objet métier de base que l'exemple de code précédent utilise.
Imports System
Imports System.Collections
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace Samples.AspNet.VB
Public Class EmployeeLogic
Public Sub New()
Throw New NotSupportedException("Initialize data.")
End Sub 'New
Public Sub New(ByVal data As String)
_data = data
End Sub 'New
Private _data As String
' Returns a collection of NorthwindEmployee objects.
Public Function GetAllEmployees() As ICollection
Dim al As New ArrayList()
al.Add(_data)
Return al
End Function 'GetAllEmployees
End Class 'EmployeeLogic
End Namespace ' Samples.AspNet.VB
namespace Samples.AspNet.CS {
using System;
using System.Collections;
using System.Web.UI;
using System.Web.UI.WebControls;
public class EmployeeLogic {
public EmployeeLogic() {
throw new NotSupportedException("Initialize data.");
}
public EmployeeLogic(string data) {
_data = data;
}
private string _data;
// Returns a collection of NorthwindEmployee objects.
public ICollection GetAllEmployees () {
ArrayList al = new ArrayList();
al.Add(_data);
return al;
}
}
}
Informations de version
.NET FrameworkPris en charge dans : 4, 3.5, 3.0, 2.0
Plateformes
Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2
Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.
Sécurité des threads
Tous les membres static ( Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Voir aussi
|