ObjectDataSourceDisposingEventArgs ObjectDataSourceDisposingEventArgs ObjectDataSourceDisposingEventArgs ObjectDataSourceDisposingEventArgs Class

定義

ObjectDisposing コントロールの ObjectDataSource イベントのデータを提供します。Provides data for the ObjectDisposing event of the ObjectDataSource control.

public ref class ObjectDataSourceDisposingEventArgs : System::ComponentModel::CancelEventArgs
public class ObjectDataSourceDisposingEventArgs : System.ComponentModel.CancelEventArgs
type ObjectDataSourceDisposingEventArgs = class
    inherit CancelEventArgs
Public Class ObjectDataSourceDisposingEventArgs
Inherits CancelEventArgs
継承
ObjectDataSourceDisposingEventArgsObjectDataSourceDisposingEventArgsObjectDataSourceDisposingEventArgsObjectDataSourceDisposingEventArgs

このセクションには、2 つのコード例が含まれています。This section contains two code examples. 最初のコード例では、ビジネスオブジェクトObjectDataSourceを含むコントロールGridViewとコントロールを使用して情報を表示する方法を示します。The first code example demonstrates how to use an ObjectDataSource control with a business object and a GridView control to display information. 2番目のコード例では、最初のコード例で使用している中間層ビジネスオブジェクトの例を示します。The second code example provides the example middle-tier business object that the first code example uses.

ビジネスオブジェクトObjectDataSource GridViewとコントロールを使用して情報を表示する方法を次のコード例に示します。The following code example demonstrates how to use an ObjectDataSource control with a business object and a GridView control to display information. Web ページで実行されるすべてのデータ操作に対して、(時間またはリソースの観点から) 非常に高価なビジネスオブジェクトを作成することができます。You might work with a business object that is very expensive (in terms of time or resources) to create for every data operation that your Web page performs. 高価なオブジェクトを操作する方法の1つとして、そのインスタンスを1回作成した後、データ操作ごとに作成して破棄するのではなく、後続の操作用にキャッシュする方法があります。One way to work with an expensive object might be to create an instance of it once, and then cache it for subsequent operations instead of creating and destroying it for every data operation. この例は、このパターンを示しています。This example demonstrates this pattern. ObjectCreatingイベントを処理して、最初にオブジェクトのキャッシュを確認してから、インスタンスがまだキャッシュされていない場合にのみインスタンスを作成することができます。You can handle the ObjectCreating event to check the cache for an object first, and then create an instance, only if one is not already cached. 次に、 ObjectDisposingイベントを処理して、ビジネスオブジェクトを破棄するのではなく、将来使用するためにキャッシュします。Then, handle the ObjectDisposing event to cache the business object for future use, instead of destroying it. このCancelEventArgs.Cancel例では、 true ObjectDataSourceDisposingEventArgsオブジェクトのプロパティがObjectDataSourceに設定されており、がインスタンスでDisposeメソッドを呼び出さないように指示しています。In this example, the CancelEventArgs.Cancel property of the ObjectDataSourceDisposingEventArgs object is set to true, to direct the ObjectDataSource to not call the Dispose method on the instance.

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

// Instead of creating and destroying the business object each time, the 
// business object is cached in the ASP.NET Cache.
private void GetEmployeeLogic(object sender, ObjectDataSourceEventArgs e)
{
    // First check to see if an instance of this object already exists in the Cache.
    EmployeeLogic cachedLogic;
    
    cachedLogic = Cache["ExpensiveEmployeeLogicObject"] as EmployeeLogic;
    
    if (null == cachedLogic) {
            cachedLogic = new EmployeeLogic();            
    }
        
    e.ObjectInstance = cachedLogic;     
}

private void ReturnEmployeeLogic(object sender, ObjectDataSourceDisposingEventArgs e)
{    
    // Get the instance of the business object that the ObjectDataSource is working with.
    EmployeeLogic cachedLogic = e.ObjectInstance as EmployeeLogic;        
    
    // Test to determine whether the object already exists in the cache.
    EmployeeLogic temp = Cache["ExpensiveEmployeeLogicObject"] as EmployeeLogic;
    
    if (null == temp) {
        // If it does not yet exist in the Cache, add it.
        Cache.Insert("ExpensiveEmployeeLogicObject", cachedLogic);
    }
    
    // Cancel the event, so that the object will 
    // not be Disposed if it implements IDisposable.
    e.Cancel = true;
}
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <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="GetCreateTime"          
          typename="Samples.AspNet.CS.EmployeeLogic"
          onobjectcreating="GetEmployeeLogic"
          onobjectdisposing="ReturnEmployeeLogic" >
        </asp:objectdatasource>        

    </form>
  </body>
</html>
<%@ 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">

' Instead of creating and destroying the business object each time, the 
' business object is cached in the ASP.NET Cache.
Sub GetEmployeeLogic(sender As Object, e As ObjectDataSourceEventArgs)

    ' First check to see if an instance of this object already exists in the Cache.
    Dim cachedLogic As EmployeeLogic 
    
    cachedLogic = CType( Cache("ExpensiveEmployeeLogicObject"), EmployeeLogic)
    
    If (cachedLogic Is Nothing) Then
            cachedLogic = New EmployeeLogic            
    End If
        
    e.ObjectInstance = cachedLogic
    
End Sub ' GetEmployeeLogic

Sub ReturnEmployeeLogic(sender As Object, e As ObjectDataSourceDisposingEventArgs)
    
    ' Get the instance of the business object that the ObjectDataSource is working with.
    Dim cachedLogic  As EmployeeLogic  
    cachedLogic = CType( e.ObjectInstance, EmployeeLogic)
    
    ' Test to determine whether the object already exists in the cache.
    Dim temp As EmployeeLogic 
    temp = CType( Cache("ExpensiveEmployeeLogicObject"), EmployeeLogic)
    
    If (temp Is Nothing) Then
        ' If it does not yet exist in the Cache, add it.
        Cache.Insert("ExpensiveEmployeeLogicObject", cachedLogic)
    End If
    
    ' Cancel the event, so that the object will 
    ' not be Disposed if it implements IDisposable.
    e.Cancel = True
End Sub ' ReturnEmployeeLogic
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <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="GetCreateTime"          
          typename="Samples.AspNet.VB.EmployeeLogic"
          onobjectcreating="GetEmployeeLogic"
          onobjectdisposing="ReturnEmployeeLogic" >
        </asp:objectdatasource>        

    </form>
  </body>
</html>

次のコード例では、前のコード例で使用している中間層ビジネスオブジェクトの例を示します。The following code example provides an example middle-tier business object that the preceding code example uses. このコード例は、 EmployeeLogicクラスによって定義される基本的なビジネスオブジェクトで構成されています。これは、状態を維持し、ビジネスロジックをカプセル化するクラスです。The code example consists of a basic business object, defined by the EmployeeLogic class, which is a class that maintains state and encapsulates business logic. 完全な作業例を実行するには、このコードをライブラリとしてコンパイルし、ASP ページからこれらのクラスを使用する必要があります。For a complete working example, you must compile this code as a library, and then use these classes from an ASP page.

namespace Samples.AspNet.CS {

using System;
using System.Collections;
using System.Web.UI;
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 {

    public EmployeeLogic () : this(DateTime.Now) {        
    }
    
    public EmployeeLogic (DateTime creationTime) { 
        _creationTime = creationTime;
    }

    private DateTime _creationTime;
    
    // Returns a collection of NorthwindEmployee objects.
    public ICollection GetCreateTime () {
      ArrayList al = new ArrayList();
      
      // Returns creation time for this example.      
      al.Add("The business object that you are using was created at " + _creationTime);
      
      return al;
    }
  }
}
Imports System
Imports System.Collections
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace Samples.AspNet.VB

  Public Class EmployeeLogic
    
    
    Public Sub New() 
        MyClass.New(DateTime.Now)
    
    End Sub 'New
    
    
    Public Sub New(ByVal creationTime As DateTime) 
        _creationTime = creationTime
    
    End Sub 'New
    
    Private _creationTime As DateTime
    
    
    ' Returns a collection of NorthwindEmployee objects.
    Public Function GetCreateTime() As ICollection 
        Dim al As New ArrayList()
        
        ' Returns creation time for this example.      
        al.Add("The business object that you are using was created at " + _creationTime)
        
        Return al
    
    End Function 'GetCreateTime
  End Class 'EmployeeLogic
End Namespace ' Samples.AspNet.VB

注釈

クラスは、 OnObjectDisposingメソッドで使用されます。これにより、 ObjectDataSourceコントロールとビジネスオブジェクトを使用するデータ操作が実行された後、ビジネスオブジェクトが破棄される前に、ビジネスオブジェクトインスタンスにアクセスできるようになります。 ObjectDataSourceDisposingEventArgsThe ObjectDataSourceDisposingEventArgs class is used in the OnObjectDisposing method to provide access to the business object instance after any data operations that are using the ObjectDataSource control and business object are performed, but before the business object is destroyed. ビジネスオブジェクトには、 ObjectInstanceプロパティを使用してアクセスします。The business object is accessed using the ObjectInstance property. ObjectDisposingイベントを処理するデリゲートを追加することにより、ビジネスオブジェクトのパブリックに公開されているメンバーにアクセスして、最終的な作業やクリーンアップを実行できます。By adding a delegate to handle the ObjectDisposing event, you can access any publicly exposed members of the business object to perform any final work or clean up.

データ操作をObjectDataSource OnObjectDisposing 実行するメソッドがメソッドの場合、このメソッドはコントロールによって呼び出さstaticれません。The OnObjectDisposing method is not called by the ObjectDataSource control, if the method that performs data operations is a static method. メソッドが静的である場合、ビジネスオブジェクトインスタンスは作成されません。No business object instance is created when the method is static.

コントロールObjectDataSourceは、そのライフサイクルのさまざまな時点で基になるビジネスオブジェクトを操作するために処理できる多くのイベントを公開します。The ObjectDataSource control exposes many events that you can handle to work with the underlying business object at various times in its lifecycle. 次の表に、イベントと、関連EventArgs付けられているクラスおよびイベントハンドラーデリゲートを示します。The following table lists the events and the associated EventArgs classes and event handler delegates.

eventEvent EventArgsEventArgs EventHandlerEventHandler
ObjectCreatingObjectCreating.

ビジネスオブジェクトのインスタンスが作成される直前に発生します。Occurs immediately before the instance of the business object is created.
ObjectDataSourceEventArgs ObjectDataSourceObjectEventHandler
ObjectCreatedObjectCreated.

ビジネスオブジェクトのインスタンスが作成された直後に発生します。Occurs immediately after the instance of the business object is created.
ObjectDataSourceEventArgs ObjectDataSourceObjectEventHandler
SelectingSelecting.

データが取得される前に発生します。Occurs before the data is retrieved.
ObjectDataSourceSelectingEventArgs ObjectDataSourceSelectingEventHandler
InsertingUpdating、および DeletingInserting, Updating, and Deleting.

挿入、更新、または削除の各操作が実行される前に発生します。Occur before an insert, update, or delete operation is performed.
ObjectDataSourceMethodEventArgs ObjectDataSourceMethodEventHandler
Selected

データが取得された後に発生します。Occurs after the data is retrieved.
ObjectDataSourceStatusEventArgs ObjectDataSourceStatusEventHandler
InsertedUpdated、および DeletedInserted, Updated, and Deleted.

挿入、更新、または削除の各操作が完了した後に発生します。Occur after the insert, update, or delete operation is completed.
ObjectDataSourceStatusEventArgs ObjectDataSourceStatusEventHandler
ObjectDisposingObjectDisposing.

ビジネスオブジェクトが破棄される前に発生します。Occurs before a business object is destroyed.
ObjectDataSourceDisposingEventArgs ObjectDataSourceDisposingEventHandler

コンストラクター

ObjectDataSourceDisposingEventArgs(Object) ObjectDataSourceDisposingEventArgs(Object) ObjectDataSourceDisposingEventArgs(Object) ObjectDataSourceDisposingEventArgs(Object)

指定されたオブジェクトを使用して、ObjectDataSourceDisposingEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the ObjectDataSourceDisposingEventArgs class using the specified object.

プロパティ

Cancel Cancel Cancel Cancel

イベントをキャンセルするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
ObjectInstance ObjectInstance ObjectInstance ObjectInstance

ObjectDataSource コントロールがデータ操作を行うときに使用するビジネス オブジェクトを表すオブジェクトを取得します。Gets an object that represents the business object with which the ObjectDataSource control performs data operations.

メソッド

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

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

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

既定のハッシュ関数として機能します。Serves as the default hash function.

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

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

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

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

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

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください