DetailsViewPageEventArgs

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

DetailsViewPageEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class DetailsViewPageEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As DetailsViewPageEventArgs

C#

public class DetailsViewPageEventArgs : CancelEventArgs

C++

public ref class DetailsViewPageEventArgs :
 public CancelEventArgs

J#

public class DetailsViewPageEventArgs extends
 CancelEventArgs

JScript

public class DetailsViewPageEventArgs extends
 CancelEventArgs

解説

DetailsView コントロールは、コントロール内のページャ ボタン (CommandName プロパティが "Page" に設定されたボタン) がクリックされたときに、DetailsView コントロールでページング操作を処理する前に PageIndexChanging イベントを発生させます。これにより、このイベントが発生したときにカスタム ルーチン (キャンセル操作やページング操作など) を実行するイベント ハンドラを提供できます。

メモ
通常、ページャ ボタンは、DetailsView コントロールのページ行に配置されます。

DetailsViewPageEventArgs オブジェクトがイベント ハンドラに渡され、これによりユーザーが選択したページのインデックスを確認したり、ページング操作をキャンセルする必要があるかどうかを示したりできます。ユーザーが選択したページのインデックスを確認するには、NewPageIndex プロパティを使用します。ページング操作をキャンセルするには、DetailsViewPageEventArgs オブジェクトの Cancel プロパティを true に設定します。

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

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

使用例

PageIndexChanging イベントのイベント ハンドラに渡される DetailsViewPageEventArgs オブジェクトを使用して、DetailsView コントロールが編集モードになっているときにユーザーが別のページに移動しようとした場合にページング操作をキャンセルする方法のコード例を次に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">
  
  Sub CustomerDetailsView_PageIndexChanging(ByVal
 sender As Object, ByVal
 e As DetailsViewPageEventArgs)
  
    ' Cancel the paging operation if the DetailsView control 
    ' in edit mode.
    If CustomerDetailsView.CurrentMode = DetailsViewMode.Edit
 Then
    
      e.Cancel = True
      
      ' Display an error message.
      Dim newPage As Integer
 = e.NewPageIndex + 1
      MessageLabel.Text = "Please update the current record before
 to moving to page " & _
        newPage.ToString() & "."
    
    End If
      
  End Sub

  Sub CustomerDetailsView_ModeChanging(ByVal
 sender As Object, ByVal
 e As DetailsViewModeEventArgs)
  
    ' Clear the message label when the user cancels edit mode.
    If e.CancelingEdit Then
    
      MessageLabel.Text = ""
    
    End If
      
  End Sub
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DetailsViewPageEventArgs Example</h3>
                       
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          autogeneraterows="true"
          autogenerateeditbutton="true"
          datakeynames="CustomerID"   
          allowpaging="true"
          onpageindexchanging="CustomerDetailsView_PageIndexChanging"
 
          onmodechanging="CustomerDetailsView_ModeChanging"
          runat="server">
            
          <pagersettings position="Bottom"/>
 
                    
        </asp:detailsview>
        
        <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_PageIndexChanging(Object sender, DetailsViewPageEventArgs
 e)
  {
    // Cancel the paging operation if the DetailsView control 
    // in edit mode.
    if (CustomerDetailsView.CurrentMode == DetailsViewMode.Edit)
    {
      e.Cancel = true;
      
      // Display an error message.
      int newPage = e.NewPageIndex + 1;
      MessageLabel.Text = "Please update the current record before to moving
 to page " + 
        newPage.ToString() + ".";
    }
  }

  void CustomerDetailsView_ModeChanging(Object sender, DetailsViewModeEventArgs
 e)
  {
    // Clear the message label when the user cancels edit mode.
    if (e.CancelingEdit)
    {
      MessageLabel.Text = "";
    }
  }
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DetailsViewPageEventArgs Example</h3>
                       
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          autogeneraterows="true"
          autogenerateeditbutton="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          onpageindexchanging="CustomerDetailsView_PageIndexChanging" 
          onmodechanging="CustomerDetailsView_ModeChanging"
          runat="server">
            
          <pagersettings position="Bottom"/> 
                    
        </asp:detailsview>
        
        <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.DetailsViewPageEventArgs

スレッド セーフ

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

参照

関連項目
DetailsViewPageEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewPageEventHandler
CancelEventArgs
DetailsView.PageIndexChanging イベント
Cancel
NewPageIndex
OnPageIndexChanging

DetailsViewPageEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    newPageIndex As Integer _
)

Visual Basic (使用法)

Dim newPageIndex As Integer

Dim instance As New DetailsViewPageEventArgs(newPageIndex)

C#

public DetailsViewPageEventArgs (
    int newPageIndex
)

C++

public:
DetailsViewPageEventArgs (
    int newPageIndex
)

J#

public DetailsViewPageEventArgs (
    int newPageIndex
)

JScript

public function DetailsViewPageEventArgs (
    newPageIndex : int
)

パラメータ

newPageIndex

表示する新しいページのインデックス。

解説

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

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

プロパティ	初期値
NewPageIndex	newPageIndex パラメータの値。

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

プラットフォーム

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

参照

関連項目
DetailsViewPageEventArgs クラス
DetailsViewPageEventArgs メンバ
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewPageEventHandler
DetailsView.PageIndexChanging イベント
NewPageIndex
OnPageIndexChanging

DetailsViewPageEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	NewPageIndex	DetailsView コントロールに表示する新しいページのインデックスを取得または設定します。

参照

関連項目

DetailsViewPageEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewPageEventHandler
CancelEventArgs
DetailsView.PageIndexChanging イベント
Cancel
NewPageIndex
OnPageIndexChanging

DetailsViewPageEventArgs メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DetailsViewPageEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewPageEventHandler
CancelEventArgs
DetailsView.PageIndexChanging イベント
Cancel
NewPageIndex
OnPageIndexChanging

DetailsViewPageEventArgs メンバ

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

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

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

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

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	NewPageIndex	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 から継承されます。)

参照

関連項目

DetailsViewPageEventArgs クラス
System.Web.UI.WebControls 名前空間
DetailsView クラス
DetailsViewPageEventHandler
CancelEventArgs
DetailsView.PageIndexChanging イベント
Cancel
NewPageIndex
OnPageIndexChanging