DetailsViewModeEventArgs

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

DetailsViewModeEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class DetailsViewModeEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As DetailsViewModeEventArgs

C#

public class DetailsViewModeEventArgs : CancelEventArgs

C++

public ref class DetailsViewModeEventArgs :
 public CancelEventArgs

J#

public class DetailsViewModeEventArgs extends
 CancelEventArgs

JScript

public class DetailsViewModeEventArgs extends
 CancelEventArgs

解説

DetailsView コントロールが編集、挿入、および読み取り専用の各モード間の変更を行おうとすると、実際にモードが変わる前に ModeChanging イベントが発生します。これにより、このイベントが発生するたびにカスタム ルーチン (DetailsView コントロールを特定のモード用に構成したり、モードの変更をキャンセルしたりするなど) を実行するイベント ハンドラを提供できます。

DetailsViewModeEventArgs オブジェクトがイベント ハンドラに渡されることにより、DetailsView コントロールの変更後のモードを確認したり、ユーザーが編集操作や挿入操作をキャンセルした結果として ModeChanging イベントが発生したのかどうかを確認したりできます。また、挿入操作をキャンセルする必要があることを示すこともできます。新しいモードを確認するには、NewMode プロパティを使用します。また、NewMode プロパティを DetailsViewMode 列挙値のいずれかに設定することによって、別のモードに変更することもできます。CancelingEdit プロパティを使用して、ユーザーが編集操作をキャンセルしたのかどうかを確認できます。挿入操作をキャンセルするには、Cancel プロパティを true に設定します。

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

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

使用例

ModeChanging イベントのイベント ハンドラに渡される DetailsViewModeEventArgs オブジェクトを使用して、DetailsView コントロールが編集モードに移行するときにページ行を非表示にする方法のコード例を次に示します。

Visual Basic

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

<script runat="server">

  Sub CustomerDetailsView_ModeChanging(ByVal
 sender As Object, ByVal
 e As DetailsViewModeEventArgs) Handles CustomerDetailsView.ModeChanging

    ' Use the NewMode property to determine the mode to which the 
    ' DetailsView control is transitioning.
    Select Case e.NewMode
    
      Case DetailsViewMode.Edit
        ' Hide the pager row and clear the Label control
        ' when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = False
        MessageLabel.Text = ""

      Case DetailsViewMode.ReadOnly
        ' Display the pager row and confirmation message
        ' when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = True
        If e.CancelingEdit Then
        
          MessageLabel.Text = "Update canceled."
        
        Else
        
          MessageLabel.Text = "Update completed."
        
        End If

      Case DetailsViewMode.Insert
        ' Cancel the mode change if the DetailsView
        ' control attempts to transition to insert 
        ' mode.
        e.Cancel = True

      Case Else
        MessageLabel.Text = "Unsupported mode."
          
    End Select
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>DetailsViewModeEventArgs Example</h3>
                
      <asp:detailsview id="CustomerDetailsView"
        datasourceid="DetailsViewSource"
        datakeynames="CustomerID"
        autogeneraterows="true"
        autogenerateeditbutton="true" 
        allowpaging="true"
        runat="server">

      </asp:detailsview>
      
      <br/><br/>
      
      <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]"
        updatecommand="Update [Customers] Set 
          [CompanyName]=@CompanyName, [Address]=@Address, 
          [City]=@City, [PostalCode]=@PostalCode, 
          [Country]=@Country 
          Where [CustomerID]=@CustomerID" 
        connectionstring=
          "<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
            
    </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomerDetailsView_ModeChanging(Object sender, DetailsViewModeEventArgs
 e)
  {

    // Use the NewMode property to determine the mode to which the 
    // DetailsView control is transitioning.
    switch (e.NewMode)
    {
      case DetailsViewMode.Edit:
        // Hide the pager row and clear the Label control
        // when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = false;
        MessageLabel.Text = "";
        break;
      case DetailsViewMode.ReadOnly:
        // Display the pager row and confirmation message
        // when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = true;
        if (e.CancelingEdit)
        {
          MessageLabel.Text = "Update canceled.";
        }
        else
        {
          MessageLabel.Text = "Update completed.";
        }
        break;
      case DetailsViewMode.Insert:
        // Cancel the mode change if the DetailsView
        // control attempts to transition to insert 
        // mode.
        e.Cancel = true;
        break;
      default:
        MessageLabel.Text = "Unsupported mode.";
        break;
    }
    
  }

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>DetailsViewModeEventArgs Example</h3>
                
      <asp:detailsview id="CustomerDetailsView"
        datasourceid="DetailsViewSource"
        datakeynames="CustomerID"
        autogeneraterows="true"
        autogenerateeditbutton="true" 
        allowpaging="true"
        onmodechanging="CustomerDetailsView_ModeChanging" 
        runat="server">

      </asp:detailsview>
      
      <br/><br/>
      
      <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]"
        updatecommand="Update [Customers] Set 
          [CompanyName]=@CompanyName, [Address]=@Address, 
          [City]=@City, [PostalCode]=@PostalCode, 
          [Country]=@Country 
          Where [CustomerID]=@CustomerID" 
        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.DetailsViewModeEventArgs

スレッド セーフ

この型の 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

参照

関連項目
DetailsViewModeEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewModeEventHandler
CancelEventArgs
DetailsView.ModeChanging イベント
Cancel
CancelingEdit
NewMode

DetailsViewModeEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    mode As DetailsViewMode, _
    cancelingEdit As Boolean _
)

Visual Basic (使用法)

Dim mode As DetailsViewMode
Dim cancelingEdit As Boolean

Dim instance As New DetailsViewModeEventArgs(mode,
 cancelingEdit)

C#

public DetailsViewModeEventArgs (
    DetailsViewMode mode,
    bool cancelingEdit
)

C++

public:
DetailsViewModeEventArgs (
    DetailsViewMode mode, 
    bool cancelingEdit
)

J#

public DetailsViewModeEventArgs (
    DetailsViewMode mode, 
    boolean cancelingEdit
)

JScript

public function DetailsViewModeEventArgs (
    mode : DetailsViewMode, 
    cancelingEdit : boolean
)

パラメータ

mode

DetailsViewMode 列挙値の 1 つ。

cancelingEdit

ユーザーが編集操作をキャンセルした結果として ModeChanging イベントが発生したことを示す場合は true。それ以外の場合は false。

解説

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

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

プロパティ	初期値
CancelingEdit	cancelingEdit パラメータの値。
NewMode	mode パラメータの値。

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

プラットフォーム

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

参照

関連項目
DetailsViewModeEventArgs クラス
DetailsViewModeEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewModeEventHandler
DetailsView.ModeChanging イベント
CancelingEdit
NewMode

DetailsViewModeEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	CancelingEdit	ユーザーが編集操作をキャンセルした結果として ModeChanging イベントが発生したのかどうかを示す値を取得します。
	NewMode	DetailsView コントロールの変更後のモードを取得または設定します。

参照

関連項目

DetailsViewModeEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewModeEventHandler
CancelEventArgs
DetailsView.ModeChanging イベント
Cancel
CancelingEdit
NewMode

DetailsViewModeEventArgs メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DetailsViewModeEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewModeEventHandler
CancelEventArgs
DetailsView.ModeChanging イベント
Cancel
CancelingEdit
NewMode

DetailsViewModeEventArgs メンバ

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

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

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

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

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	CancelingEdit	ユーザーが編集操作をキャンセルした結果として ModeChanging イベントが発生したのかどうかを示す値を取得します。
	NewMode	DetailsView コントロールの変更後のモードを取得または設定します。

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DetailsViewModeEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewModeEventHandler
CancelEventArgs
DetailsView.ModeChanging イベント
Cancel
CancelingEdit
NewMode