DetailsViewInsertEventArgs

.NET Framework クラス ライブラリ リファレンス

DetailsViewInsertEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ItemInserting イベントのデータを提供します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Class DetailsViewInsertEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As DetailsViewInsertEventArgs

C#

public class DetailsViewInsertEventArgs : CancelEventArgs

C++

public ref class DetailsViewInsertEventArgs
 : public CancelEventArgs

J#

public class DetailsViewInsertEventArgs extends
 CancelEventArgs

JScript

public class DetailsViewInsertEventArgs extends
 CancelEventArgs

解説

DetailsView コントロールは、コントロール内の Insert ボタン (CommandName プロパティが "Insert" に設定されたボタン) がクリックされ、DetailsView コントロールが実際にレコードを挿入する前に ItemInserting イベントを発生させます。これにより、このイベントが発生するたびにカスタム ルーチン (データ ソースにレコードを挿入する前にレコードの値を HTML エンコーディングするなど) を実行するイベント ハンドラを提供できます。

DetailsViewInsertEventArgs オブジェクトがイベント ハンドラに渡されることにより、DetailsView コントロールに送信される省略可能なコマンド引数の値を確認したり、挿入操作をキャンセルする必要があることを示したりできます。コマンド引数の値を確認するには、CommandArgument プロパティを使用します。挿入操作をキャンセルするには、Cancel プロパティを true に設定します。また、Values プロパティを使用して、新規レコードのフィールド値を読み込んだり、変更したりすることもできます。

イベント処理の詳細については、「イベントの利用」を参照してください。

DetailsViewInsertEventArgs クラスのインスタンスの初期プロパティ値の一覧については、DetailsViewInsertEventArgs コンストラクタのトピックを参照してください。

使用例

ItemInserting イベントのイベント ハンドラに渡される DetailsViewInsertEventArgs オブジェクトを使用して、挿入操作をキャンセルする方法のコード例を次に示します。

Visual Basic

<%@ Page language="VB" autoeventwireup="false"
 %>

<script runat="server">

  Sub CustomerDetailsView_ItemInserting(ByVal
 sender As Object, _
    ByVal e As DetailsViewInsertEventArgs)
 _
    Handles CustomerDetailsView.ItemInserting
  
    ' Use the Values property to retrieve the key field value.
    Dim keyValue As String
 = e.Values("CustomerID").ToString()

    ' Insert the record only if the key field is four characters
    ' long; otherwise, cancel the insert operation.
    If keyValue.Length = 4 Then
    
      ' Change the key field value to upper case before inserting 
      ' the record in the data source.
      e.Values("CustomerID") = keyValue.ToUpper()
      
      MessageLabel.Text = ""
    
    Else
    
      MessageLabel.Text = "The key field must have four digits."
      e.Cancel = True
    
    End If

  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>DetailsViewInsertEventArgs Example</h3>
                
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogenerateinsertbutton="true"  
          autogeneraterows="true"
          allowpaging="true"
          oniteminserting="CustomerDetailsView_ItemInserting"
 
          runat="server">
               
          <fieldheaderstyle backcolor="Navy"
            forecolor="White"/>
                    
        </asp:detailsview>
        
        <asp:label id="MessageLabel"
          forecolor="Red"
          runat="server"/>
            
        <!-- This example uses Microsoft SQL Server and connects
  -->
        <!-- to the Northwind sample database. Use an ASP.NET
     -->
        <!-- expression to retrieve the connection string
 value   -->
        <!-- from the web.config file.                            -->
        <asp:sqldatasource id="DetailsViewSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], 
            [City], [PostalCode], [Country] From [Customers]"
          insertcommand="INSERT INTO [Customers]([CustomerID], 
            [CompanyName], [Address], [City], [PostalCode], 
            [Country]) VALUES (@CustomerID, @CompanyName, @Address, 
            @City, @PostalCode, @Country)"
          connectionstring=
          "<%$ ConnectionStrings:NorthWindConnectionString%>"
 
          runat="server"/>
            
      </form>
  </body>
</html>

C#

<%@ Page language="C#" %>

<script runat="server">

  void CustomerDetailsView_ItemInserting(Object sender, 
    DetailsViewInsertEventArgs e)
  {
    // Use the Values property to retrieve the key field value.
    String keyValue = e.Values["CustomerID"].ToString();

    // Insert the record only if the key field is four characters
    // long; otherwise, cancel the insert operation.
    if (keyValue.Length == 4)
    {
      // Change the key field value to upper case before inserting 
      // the record in the data source.
      e.Values["CustomerID"] = keyValue.ToUpper();

      MessageLabel.Text = "";
    }
    else
    {
      MessageLabel.Text = "The key field must have four digits.";
      e.Cancel = true;
    }

  }

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>DetailsViewInsertEventArgs Example</h3>
                
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogenerateinsertbutton="true"  
          autogeneraterows="true"
          allowpaging="true"
          oniteminserting="CustomerDetailsView_ItemInserting" 
          runat="server">
               
          <fieldheaderstyle backcolor="Navy"
            forecolor="White"/>
                    
        </asp:detailsview>
        
        <asp:label id="MessageLabel"
          forecolor="Red"
          runat="server"/>
            
        <!-- This example uses Microsoft SQL Server and connects  -->
        <!-- to the Northwind sample database. Use an ASP.NET     -->
        <!-- expression to retrieve the connection string value
   -->
        <!-- from the web.config file.                            -->
        <asp:sqldatasource id="DetailsViewSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], 
            [City], [PostalCode], [Country] From [Customers]"
          insertcommand="INSERT INTO [Customers]([CustomerID], 
            [CompanyName], [Address], [City], [PostalCode], 
            [Country]) VALUES (@CustomerID, @CompanyName, @Address, 
            @City, @PostalCode, @Country)"
          connectionstring=
          "<%$ ConnectionStrings:NorthWindConnectionString%>" 
          runat="server"/>
            
      </form>
  </body>
</html>

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.DetailsViewInsertEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DetailsViewInsertEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewInsertEventHandler
CancelEventArgs
DetailsView.ItemInserting イベント
Cancel
CommandArgument
Values

DetailsViewInsertEventArgs コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

DetailsViewInsertEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    commandArgument As Object _
)

Visual Basic (使用法)

Dim commandArgument As Object

Dim instance As New DetailsViewInsertEventArgs(commandArgument)

C#

public DetailsViewInsertEventArgs (
    Object commandArgument
)

C++

public:
DetailsViewInsertEventArgs (
    Object^ commandArgument
)

J#

public DetailsViewInsertEventArgs (
    Object commandArgument
)

JScript

public function DetailsViewInsertEventArgs
 (
    commandArgument : Object
)

パラメータ

commandArgument

DetailsView コントロールに渡される、省略可能なコマンド引数。

解説

このコンストラクタを使用して、DetailsViewInsertEventArgs クラスの新しいインスタンスを初期化します。

DetailsViewInsertEventArgs クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
CommandArgument	commandArgument パラメータの値。

メモ
このコンストラクタは、主にコントロールの開発者がイベントを発生させる場合に使用します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DetailsViewInsertEventArgs クラス
DetailsViewInsertEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewInsertEventHandler
DetailsView.ItemInserting イベント
CommandArgument

DetailsViewInsertEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	CommandArgument	DetailsView コントロールに渡される、挿入処理のコマンド引数を取得します。
	Values	挿入するレコードのフィールドの名前/値ペアを格納しているディクショナリを取得します。

参照

関連項目

DetailsViewInsertEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewInsertEventHandler
CancelEventArgs
DetailsView.ItemInserting イベント
Cancel
CommandArgument
Values

DetailsViewInsertEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

DetailsViewInsertEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewInsertEventHandler
CancelEventArgs
DetailsView.ItemInserting イベント
Cancel
CommandArgument
Values

DetailsViewInsertEventArgs メンバ

ItemInserting イベントのデータを提供します。

DetailsViewInsertEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	DetailsViewInsertEventArgs	DetailsViewInsertEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	CommandArgument	DetailsView コントロールに渡される、挿入処理のコマンド引数を取得します。
	Values	挿入するレコードのフィールドの名前/値ペアを格納しているディクショナリを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

DetailsViewInsertEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewInsertEventHandler
CancelEventArgs
DetailsView.ItemInserting イベント
Cancel
CommandArgument
Values