ObjectDataSource.InsertMethod プロパティ

リファレンス

定義

名前空間:: System.Web.UI.WebControls

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ObjectDataSource コントロールがデータを挿入するために呼び出すメソッドまたは関数の名前を取得または設定します。

public:
 property System::String ^ InsertMethod { System::String ^ get(); void set(System::String ^ value); };

public string InsertMethod { get; set; }

member this.InsertMethod : string with get, set

Public Property InsertMethod As String

プロパティ値

String

データを挿入するために ObjectDataSource が使用するメソッドまたは関数の名前を表す文字列。既定値は、空の文字列 ("") です。

例

このセクションには、2 つのコード例が含まれています。最初のコード例では、ビジネスオブジェクトとコントロールでオブジェクトを ObjectDataSource 使用してデータを DetailsView 挿入する方法を示します。 2 番目のコード例では、最初のコード例で使用される中間層ビジネスオブジェクトの例を示します。

次のコード例では、ビジネスオブジェクトとコントロールでコントロールを ObjectDataSource 使用してデータを DetailsView 挿入する方法を示します。最初に、にはDetailsView、自動的に生成された [挿入] ボタンと共に新しいNorthwindEmployeeレコードが表示されます。コントロールの DetailsView フィールドにデータを入力したら、[ 挿入 ] ボタンをクリックします。プロパティは InsertMethod 、挿入操作を実行するメソッドを識別します。

この例では、メソッドを UpdateEmployeeInfo 使用して挿入を実行します。ただし、データを NorthwindEmployee 挿入するにはパラメーターが必要です。このため、コントロールが自動的に渡す文字列の DetailsView コレクションでは十分ではありません。デリゲートは NorthwindEmployeeInserting イベントを ObjectDataSourceMethodEventHandler 処理 Inserting するオブジェクトであり、操作を続行する前に入力パラメーターを Insert 操作できます。メソッドにはUpdateEmployeeInfoパラメーターとしてオブジェクトが必要NorthwindEmployeeであるため、1 つは文字列のコレクションを使用して作成され、メソッドが予期するパラメーター名 (ne) を使用してコレクションに追加されますInputParameters。コントロールで使用するために特別に設計されていない型とメソッドを持つデータソースとして既存の中間層オブジェクトを使用する場合は、次のような手順を ObjectDataSource 実行できます。

操作が Insert 実行されると、プロパティによって InsertMethod 識別されるメソッドが呼び出されます。オブジェクトのメソッドに Insert パラメーターを含むメソッドシグネチャがある場合、コレクションには、 InsertParameters メソッドが正常に完了するためのメソッドシグネチャパラメーターと一致する名前のパラメーターが Insert 含まれている必要があります。

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %>
<%@ 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 NorthwindEmployeeInserting(object source, ObjectDataSourceMethodEventArgs e)
{
  // The business object expects a custom type. Build it
  // and add it to the parameters collection.
  
  IDictionary paramsFromPage = e.InputParameters;

  NorthwindEmployee ne = new NorthwindEmployee();

  ne.FirstName  = paramsFromPage["FirstName"].ToString();
  ne.LastName   = paramsFromPage["LastName"].ToString();
  ne.Title      = paramsFromPage["Title"].ToString();
  ne.Courtesy   = paramsFromPage["Courtesy"].ToString();
  ne.Supervisor = Int32.Parse(paramsFromPage["Supervisor"].ToString());

  paramsFromPage.Clear();
  paramsFromPage.Add("ne", ne);
}

</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:detailsview
          id="DetailsView1"
          runat="server"
          autogenerateinsertbutton="True"
          datasourceid="ObjectDataSource1">
        </asp:detailsview>

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetEmployee"
          insertmethod="UpdateEmployeeInfo"
          oninserting="NorthwindEmployeeInserting"
          typename="Samples.AspNet.CS.EmployeeLogic"
          >
          <selectparameters>
            <asp:parameter name="anID" defaultvalue="-1" />
          </selectparameters>
        </asp:objectdatasource>

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

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB" Assembly="Samples.AspNet.VB" %>
<%@ 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 NorthwindEmployeeInserting(source As Object, e As ObjectDataSourceMethodEventArgs)

  ' The GridView control passes an array of strings in the parameters
  ' collection because that is the type it knows how to work with.
  ' However, the business object expects a custom type. Build it
  ' and add it to the parameters collection.
  Dim paramsFromPage As IDictionary = e.InputParameters

  Dim ne As New NorthwindEmployee()
  ne.FirstName  = paramsFromPage("FirstName").ToString()
  ne.LastName   = paramsFromPage("LastName").ToString()
  ne.Title      = paramsFromPage("Title").ToString()
  ne.Courtesy   = paramsFromPage("Courtesy").ToString()
  ne.Supervisor = Int32.Parse(paramsFromPage("Supervisor").ToString())
  
  paramsFromPage.Clear()
  paramsFromPage.Add("ne", ne)
End Sub ' NorthwindEmployeeInserting

</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:detailsview
          id="DetailsView1"
          runat="server"
          autogenerateinsertbutton="True"
          datasourceid="ObjectDataSource1">
        </asp:detailsview>

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetEmployee"
          insertmethod="UpdateEmployeeInfo"
          oninserting="NorthwindEmployeeInserting"
          typename="Samples.AspNet.VB.EmployeeLogic" >
          <selectparameters>
            <asp:parameter name="anID" defaultvalue="-1" />
          </selectparameters>
        </asp:objectdatasource>

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

次のコード例では、前のコード例で使用する中間層ビジネスオブジェクトの例を示します。このコード例は、次の 2 つの基本クラスで構成されています。

クラス。 EmployeeLogic これは、ビジネスロジックをカプセル化するステートレスクラスです。
NorthwindEmployeeクラス。これは、データ層からデータを読み込んで永続化するために必要な基本的な機能のみを含むモデルクラスです。

便宜上、追加 NorthwindDataException のクラスが提供されます。完全な動作例については、これらのクラスをコンパイルして使用する必要があります。 UpdateEmployeeInfoメソッドは完全には実装されていないため、この例を試しても Northwind Traders データベースにデータを挿入しません。

namespace Samples.AspNet.CS {

using System;
using System.Collections;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;
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 {

    // Returns a collection of NorthwindEmployee objects.
    public static ICollection GetAllEmployees () {
      ArrayList al = new ArrayList();

      ConnectionStringSettings cts = ConfigurationManager.ConnectionStrings["NorthwindConnection"];

      SqlDataSource sds
        = new SqlDataSource(cts.ConnectionString,
                            "SELECT EmployeeID FROM Employees");
      try {
        IEnumerable IDs = sds.Select(DataSourceSelectArguments.Empty);

        // Iterate through the Enumeration and create a
        // NorthwindEmployee object for each ID.
        IEnumerator enumerator = IDs.GetEnumerator();
        while (enumerator.MoveNext()) {
          // The IEnumerable contains DataRowView objects.
          DataRowView row = enumerator.Current as DataRowView;
          string id = row["EmployeeID"].ToString();
          NorthwindEmployee nwe = new NorthwindEmployee(id);
          // Add the NorthwindEmployee object to the collection.
          al.Add(nwe);
        }
      }
      finally {
        // If anything strange happens, clean up.
        sds.Dispose();
      }

      return al;
    }

    public static NorthwindEmployee GetEmployee(object anID) {
      if (anID.Equals("-1") ||
          anID.Equals(DBNull.Value) ) {
        return new NorthwindEmployee();
      }
      else {
        return new NorthwindEmployee(anID);
      }
    }

    public static void UpdateEmployeeInfo(NorthwindEmployee ne) {
      bool retval = ne.Save();
      if (! retval) { throw new NorthwindDataException("UpdateEmployee failed."); }
    }

    public static void DeleteEmployee(NorthwindEmployee ne) {
      bool retval = ne.Delete();
      if (! retval) { throw new NorthwindDataException("DeleteEmployee failed."); }
    }

    // And so on...
  }

  public class NorthwindEmployee {

    public NorthwindEmployee () {
      ID = DBNull.Value;
      lastName = "";
      firstName = "";
      title="";
      titleOfCourtesy = "";
      reportsTo = -1;
    }

    public NorthwindEmployee (object anID) {
      this.ID = anID;

      SqlConnection conn
        = new SqlConnection (ConfigurationManager.ConnectionStrings["NorthwindConnection"].ConnectionString);
      SqlCommand sc =
        new SqlCommand(" SELECT FirstName,LastName,Title,TitleOfCourtesy,ReportsTo " +
                       " FROM Employees " +
                       " WHERE EmployeeID = @empId",
                       conn);
      // Add the employee ID parameter and set its value.
      sc.Parameters.Add(new SqlParameter("@empId",SqlDbType.Int)).Value = Int32.Parse(anID.ToString());
      SqlDataReader sdr = null;

      try {
        conn.Open();
        sdr = sc.ExecuteReader();

        // Only loop once.
        if (sdr != null && sdr.Read()) {
          // The IEnumerable contains DataRowView objects.
          this.firstName        = sdr["FirstName"].ToString();
          this.lastName         = sdr["LastName"].ToString();
          this.title            = sdr["Title"].ToString();
          this.titleOfCourtesy  = sdr["TitleOfCourtesy"].ToString();
          if (! sdr.IsDBNull(4)) {
            this.reportsTo        = sdr.GetInt32(4);
          }
        }
        else {
          throw new NorthwindDataException("Data not loaded for employee id.");
        }
      }
      finally {
        try {
          if (sdr != null) sdr.Close();
          conn.Close();
        }
        catch (SqlException) {
          // Log an event in the Application Event Log.
          throw;
        }
      }
    }

    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 title;
    public String Title {
      get { return title; }
      set { title = value; }
    }

    private string titleOfCourtesy;
    public string Courtesy {
      get { return titleOfCourtesy; }
      set { titleOfCourtesy = value; }
    }

    private int    reportsTo;
    public int Supervisor {
      get { return reportsTo; }
      set { reportsTo = value; }
    }

    public bool Save () {
      // Implement persistence logic.
      return true;
    }

    public bool Delete () {
      // Implement delete logic.
      return true;
    }
  }

  internal class NorthwindDataException: Exception {
    public NorthwindDataException(string msg) : base (msg) { }
  }
}

Imports System.Collections
Imports System.Configuration
Imports System.Data
Imports System.Data.SqlClient
Imports System.Web.UI
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 al As New ArrayList()

      Dim cts As ConnectionStringSettings = ConfigurationManager.ConnectionStrings("NorthwindConnection")

      Dim sds As New SqlDataSource(cts.ConnectionString, "SELECT EmployeeID FROM Employees")

      Try
         Dim IDs As IEnumerable = sds.Select(DataSourceSelectArguments.Empty)

         ' Iterate through the Enumeration and create a
         ' NorthwindEmployee object for each ID.
         Dim enumerator As IEnumerator = IDs.GetEnumerator()
         While enumerator.MoveNext()
            ' The IEnumerable contains DataRowView objects.
            Dim row As DataRowView = CType(enumerator.Current,DataRowView)
            Dim id As String = row("EmployeeID").ToString()
            Dim nwe As New NorthwindEmployee(id)
            ' Add the NorthwindEmployee object to the collection.
            al.Add(nwe)
         End While
      Finally
         ' If anything strange happens, clean up.
         sds.Dispose()
      End Try

      Return al
   End Function 'GetAllEmployees


   Public Shared Function GetEmployee(anID As Object) As NorthwindEmployee
      If anID.Equals("-1") OrElse anID.Equals(DBNull.Value) Then
         Return New NorthwindEmployee()
      Else
         Return New NorthwindEmployee(anID)
      End If
   End Function 'GetEmployee


   Public Shared Sub UpdateEmployeeInfo(ne As NorthwindEmployee)
      Dim retval As Boolean = ne.Save()
      If Not retval Then
         Throw New NorthwindDataException("UpdateEmployee failed.")
      End If
   End Sub

   Public Shared Sub DeleteEmployee(ne As NorthwindEmployee)
      Dim retval As Boolean = ne.Delete()
      If Not retval Then
         Throw New NorthwindDataException("DeleteEmployee failed.")
      End If
   End Sub

   ' And so on...

End Class


Public Class NorthwindEmployee


   Public Sub New()
      ID = DBNull.Value
      lastName = ""
      firstName = ""
      title = ""
      titleOfCourtesy = ""
      reportsTo = - 1
   End Sub


   Public Sub New(anID As Object)
      Me.ID = anID

      Dim cts As ConnectionStringSettings = ConfigurationManager.ConnectionStrings("NorthwindConnection")

      Dim conn As New SqlConnection(cts.ConnectionString)

      Dim sc As New SqlCommand(" SELECT FirstName,LastName,Title,TitleOfCourtesy,ReportsTo " & _
                               " FROM Employees " & _
                               " WHERE EmployeeID = @empId", conn)

      ' Add the employee ID parameter and set its value.
      sc.Parameters.Add(New SqlParameter("@empId", SqlDbType.Int)).Value = Int32.Parse(anID.ToString())
      Dim sdr As SqlDataReader = Nothing

      Try
         conn.Open()
         sdr = sc.ExecuteReader()

         ' Only loop once.
         If Not (sdr Is Nothing) AndAlso sdr.Read() Then
            ' The IEnumerable contains DataRowView objects.
            Me.aFirstName = sdr("FirstName").ToString()
            Me.aLastName = sdr("LastName").ToString()
            Me.aTitle = sdr("Title").ToString()
            Me.titleOfCourtesy = sdr("TitleOfCourtesy").ToString()
            If Not sdr.IsDBNull(4) Then
               Me.reportsTo = sdr.GetInt32(4)
            End If
         Else
            Throw New NorthwindDataException("Data not loaded for employee id.")
         End If
      Finally
         Try
            If Not (sdr Is Nothing) Then
               sdr.Close()
            End If
            conn.Close()
         Catch se As SqlException
            ' Log an event in the Application Event Log.
            Throw
         End Try
      End Try
   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 aTitle As String
   Public Property Title() As String
      Get
         Return aTitle
      End Get
      Set
         aTitle = value
      End Set
   End Property

   Private titleOfCourtesy As String
   Public Property Courtesy() As String
      Get
         Return titleOfCourtesy
      End Get
      Set
         titleOfCourtesy = value
      End Set
   End Property

   Private reportsTo As Integer
   Public Property Supervisor() As Integer
      Get
         Return reportsTo
      End Get
      Set
         reportsTo = value
      End Set
   End Property

   Public Function Save() As Boolean

      ' Implement persistence logic.
      Return True

   End Function 'Save


   Public Function Delete() As Boolean

     ' Implement delete logic.
     Return True

   End Function 'Delete
End Class


Friend Class NorthwindDataException
   Inherits Exception

   Public Sub New(msg As String)
      MyBase.New(msg)
   End Sub
End Class

End Namespace

注釈

ビジネスオブジェクトは、バッチではなく、一度に 1 レコードずつデータを挿入すると想定されます。

プロパティは InsertMethod 、オブジェクトに InsertMethod 関連付けられているオブジェクトの ObjectDataSourceView プロパティに ObjectDataSource デリゲートします。

オブジェクトの有効期間

プロパティによって InsertMethod 識別されるメソッドは、インスタンスメソッドまたは static (Shared Visual Basic の場合は ) メソッドです。インスタンスメソッドの場合、プロパティで指定されたメソッドが呼び出されるたびにビジネスオブジェクトが作成され、 InsertMethod 破棄されます。プロパティが ObjectCreated 呼び出される前に、イベントと ObjectCreating イベントを処理してビジネスオブジェクトを InsertMethod 操作できます。プロパティで指定されたメソッドが ObjectDisposing 呼び出された後に発生するイベントを DeleteMethod 処理することもできます。ビジネスオブジェクトがインターフェイスを実装している IDisposable 場合、オブジェクトが Dispose 破棄される前にメソッドが呼び出されます。メソッドが static (Shared Visual Basic の場合) の場合、ビジネスオブジェクトは作成されません。、ObjectCreating、および ObjectDisposing イベントはObjectCreated処理できません。

パラメーターのマージ

パラメーターは、次の InsertParameters 3 つのソースからコレクションに追加されます。

実行時に、データバインドコントロールから。
要素から InsertParameters 、宣言的に。
プログラムによって、 Inserting メソッドから。

最初に、データバインドコントロールから生成されるすべてのパラメーターがコレクションに InsertParameters 追加されます。たとえば、コントロールが列 Name と Numberを持つコントロールにGridViewバインドされている場合ObjectDataSource、およびのNameNumberパラメーターがコレクションに追加されます。これらのパラメーターのデータ型はです string。次に、要素に一覧表示されているパラメーターが InsertParameters 追加されます。要素内のInsertParametersパラメーターが、コレクション内に既に存在するパラメーターと同じ名前で見つかった場合、既存のパラメーターは、要素でInsertParametersInsertParameters指定されているパラメーターと一致するように変更されます。通常、これはパラメーター内のデータの型を変更するために使用されます。最後に、メソッドが実行される前Insertに発生するイベントにパラメーターをInsertingプログラムで追加および削除できます。メソッドは、パラメーターがマージされた後に解決されます。メソッドの解決方法については、次のセクションで説明します。

重要

クライアントから受け取るパラメーター値を検証する必要があります。ランタイムは、パラメーター値をプロパティに置き InsertMethod 換えるだけです。

メソッドの解決

メソッドが Insert 呼び出されると、データバインドコントロールのデータフィールド、要素で InsertParameters 宣言的に作成されたパラメーター、およびイベントハンドラーに Inserting 追加されたパラメーターがすべてマージされます。 (詳細については、前のセクションを参照してください)。その後、オブジェクトは ObjectDataSource 呼び出すメソッドの検索を試みます。最初に、プロパティで指定された名前の 1 つ以上のメソッドを InsertMethod 検索します。一致するものが見つからない場合は、 InvalidOperationException 例外がスローされます。一致するものが見つかった場合は、一致するパラメーター名を検索します。たとえば、プロパティで指定された型にという名前の TypeName 2 つのメソッドがあるとします InsertARecord。 1 つは InsertARecord 1 つのパラメーターで、 IDもう InsertARecord 1 つはとの 2 つのパラメーター NameNumberを持っています。コレクションにという名前IDのInsertParametersパラメーターが 1 つしかない場合は、 InsertARecord パラメーターのみをID持つメソッドが呼び出されます。パラメーターの型は、メソッドの解決ではチェックされません。パラメーターの順序は関係ありません。

プロパティが DataObjectTypeName 設定されている場合、メソッドは別の方法で解決されます。は ObjectDataSource 、プロパティで指定された型の 1 つのパラメーターを InsertMethod 受け取るプロパティで指定された名前のメソッドを DataObjectTypeName 検索します。この場合、パラメーターの名前は重要ではありません。

適用対象

次の方法で共有