GridViewPageEventArgsとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

GridViewPageEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class GridViewPageEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As GridViewPageEventArgs

public class GridViewPageEventArgs : CancelEventArgs

C++

public ref class GridViewPageEventArgs : public
 CancelEventArgs

public class GridViewPageEventArgs extends
 CancelEventArgs

JScript

public class GridViewPageEventArgs extends
 CancelEventArgs

解説

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

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

GridViewPageEventArgs オブジェクトがイベント処理メソッドに渡されることにより、ユーザーが選択したページのインデックスを確認したり、ページング操作をキャンセルする必要があることを示したりできます。ページング操作をキャンセルするには、GridViewPageEventArgs オブジェクトの CancelEventArgs.Cancel プロパティを true に設定します。

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

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

使用例

イベント処理メソッドに渡された GridViewPageEventArgs オブジェクトを使用して、ユーザーが選択したページのインデックスを確認したり、ページング操作をキャンセルしたりする方法を次の例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomersGridView_PageIndexChanging(ByVal
 sender As Object, ByVal
 e As GridViewPageEventArgs)
    
    ' Cancel the paging operation if the user attempts to navigate
    ' to another page while the GridView control is in edit mode. 
    If CustomersGridView.EditIndex <> -1 Then
    
      ' Use the Cancel property to cancel the paging operation.
      e.Cancel = True
      
      ' Display an error message.
      Dim newPageNumber As Integer
 = e.NewPageIndex + 1
      Message.Text = "Please update the record before moving to
 page " & _
        newPageNumber.ToString() & "."
    
    Else
    
      ' Clear the error message.
      Message.Text = ""
    
    End If
    
  End Sub

  Sub CustomersGridView_RowCancelingEdit(ByVal
 sender As Object, ByVal
 e As GridViewCancelEditEventArgs)
  
    ' Clear the error message.
    Message.Text = ""
    
  End Sub

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView PageIndexChanging Example</h3>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
                
      <br/>  

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        autogenerateeditbutton="true"
        datakeynames="CustomerID"  
        onpageindexchanging="CustomersGridView_PageIndexChanging"
        onrowcancelingedit="CustomersGridView_RowCancelingEdit"
 
        runat="server">
                
        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>
                      
        <pagerstyle backcolor="LightBlue"/>
                
      </asp:gridview>
            
      <!-- 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="CustomersSource"
        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>

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

<script runat="server">

  void CustomersGridView_PageIndexChanging(Object sender, GridViewPageEventArgs
 e)
  {
    
    // Cancel the paging operation if the user attempts to navigate
    // to another page while the GridView control is in edit mode. 
    if (CustomersGridView.EditIndex != -1)
    {
      // Use the Cancel property to cancel the paging operation.
      e.Cancel = true;
      
      // Display an error message.
      int newPageNumber = e.NewPageIndex + 1;
      Message.Text = "Please update the record before moving to page "
 +
        newPageNumber.ToString() + ".";
    }
    else
    {
      // Clear the error message.
      Message.Text = "";
    }
    
  }

  void CustomersGridView_RowCancelingEdit(Object sender, GridViewCancelEditEventArgs
 e)
  {
    // Clear the error message.
    Message.Text = "";
  }

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView PageIndexChanging Example</h3>
            
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
                
      <br/>  

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        autogenerateeditbutton="true"
        datakeynames="CustomerID"  
        onpageindexchanging="CustomersGridView_PageIndexChanging"
        onrowcancelingedit="CustomersGridView_RowCancelingEdit" 
        runat="server">
                
        <pagersettings mode="Numeric"
          position="Bottom"           
          pagebuttoncount="10"/>
                      
        <pagerstyle backcolor="LightBlue"/>
                
      </asp:gridview>
            
      <!-- 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="CustomersSource"
        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.GridViewPageEventArgs

スレッドセーフ

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

参照

関連項目
GridViewPageEventArgs メンバ
System.Web.UI.WebControls 名前空間
GridView クラス
GridViewPageEventHandler
GridView.PageIndexChanging イベント
その他の技術情報
イベントの利用

GridViewPageEventArgs コンストラクタ

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

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

名前空間: 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 GridViewPageEventArgs(newPageIndex)

public GridViewPageEventArgs (
    int newPageIndex
)

C++

public:
GridViewPageEventArgs (
    int newPageIndex
)

public GridViewPageEventArgs (
    int newPageIndex
)

JScript

public function GridViewPageEventArgs (
    newPageIndex : int
)

パラメータ

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

解説

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

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

プロパティ	初期値
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
サポート対象 : 2.0

参照

関連項目
GridViewPageEventArgs クラス
GridViewPageEventArgs メンバ
System.Web.UI.WebControls 名前空間
NewPageIndex

GridViewPageEventArgs プロパティ

パブリックプロパティパブリックプロパティ

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

参照

その他の技術情報

イベントの利用

GridViewPageEventArgs メソッド

パブリックメソッドパブリックメソッド

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

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

プロテクトメソッド

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

参照

その他の技術情報

イベントの利用

GridViewPageEventArgs メンバ

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

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

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

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

パブリックプロパティ

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

パブリックメソッド

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

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

プロテクトメソッド

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