DataKeyArray

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

DataKeyArray クラス

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

DataKey オブジェクトのコレクションを表します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 DataKeyArray
    Implements ICollection, IEnumerable, IStateManager

Visual Basic (使用法)

Dim instance As DataKeyArray

C#

public sealed class DataKeyArray : ICollection,
 IEnumerable, IStateManager

C++

public ref class DataKeyArray sealed : ICollection,
 IEnumerable, IStateManager

J#

public final class DataKeyArray implements
 ICollection, IEnumerable, 
    IStateManager

JScript

public final class DataKeyArray implements
 ICollection, IEnumerable, 
    IStateManager

解説

DataKeyArray クラスは、DataKey オブジェクトのコレクションの格納と管理に使用されます。DataKey オブジェクトは、データ バインド コントロール内のレコードの主キーを表します。通常、複数のレコードを表示するデータ バインド コントロール (GridView コントロールなど) では、DataKeyArray オブジェクトを使用して、コントロールに表示されるレコードの DataKey オブジェクトを格納します。

DataKeyArray クラスは、コレクション内の項目にアクセスするために、次の方法をサポートしています。

• Item インデクサを使用して、0 から始まる特定のインデックス位置にある DataKey オブジェクトをコレクションから直接取得します。

• コレクションを反復処理するために使用できる列挙子を取得するには、GetEnumerator メソッドを使用します。

• CopyTo メソッドを使用して、コレクション内の項目を配列にコピーすることにより、この配列を使用してコレクション内の項目にアクセスできるようになります。

コレクション内の項目の総数を確認するには、Count プロパティを使用します。

使用例

インデクサを使用して DataKeyArray コレクションから DataKey オブジェクトを取得する方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomerGridView_DataBound(ByVal sender
 As Object, ByVal e As
 EventArgs) Handles CustomerGridView.DataBound
          
    ' Use the indexer to retrieve the DataKey object for the 
    ' first record.
    Dim key As DataKey = CustomerGridView.DataKeys(0)

    ' Display the the value of the primary key for the first
    ' record displayed in the GridView control.
    MessageLabel.Text = "The primary key of the first record displayed
 is " & _
      key.Value.ToString() & "."
  
  End Sub
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DataKeyArray Example</h3>
                       
        <asp:gridview id="CustomerGridView"
          datasourceid="CustomerDataSource"
          autogeneratecolumns="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          runat="server">
            
        </asp:gridview>
        
        <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="CustomerDataSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address],
 [City], [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
          runat="server"/>
            
      </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomerGridView_DataBound(Object sender, EventArgs e)
  {           
    // Use the indexer to retrieve the DataKey object for the 
    // first record.
    DataKey key = CustomerGridView.DataKeys[0];

    // Display the the value of the primary key for the first
    // record displayed in the GridView control.
    MessageLabel.Text = "The primary key of the first record displayed is "
 +
      key.Value.ToString() + ".";
  }
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DataKeyArray Example</h3>
                       
        <asp:gridview id="CustomerGridView"
          datasourceid="CustomerDataSource"
          autogeneratecolumns="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          ondatabound="CustomerGridView_DataBound" 
          runat="server">
            
        </asp:gridview>
        
        <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="CustomerDataSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], [City],
 [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
          runat="server"/>
            
      </form>
  </body>
</html>

DataKeyArray コレクションを反復処理する方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<script runat="server">

  Sub CustomerGridView_DataBound(ByVal sender
 As Object, ByVal e As
 EventArgs) Handles CustomerGridView.DataBound
    
    ' Display the the value of the primary key for each
    ' record in the GridView control.
    MessageLabel.Text = "The primary key of each record displayed
 are: <br/><br/>"

    Dim key As DataKey
    For Each key In CustomerGridView.DataKeys
    
      MessageLabel.Text += key.Value.ToString() + "<br/>"
      
    Next
    
  End Sub
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DataKeyArray Example</h3>
                       
        <asp:gridview id="CustomerGridView"
          datasourceid="CustomerDataSource"
          autogeneratecolumns="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          runat="server">
            
        </asp:gridview>
        
        <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="CustomerDataSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address],
 [City], [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
          runat="server"/>
            
      </form>
  </body>
</html>

C#

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

<script runat="server">

  void CustomerGridView_DataBound(Object sender, EventArgs e)
  {    
    // Display the the value of the primary key for each
    // record in the GridView control.
    MessageLabel.Text = "The primary key of each record displayed are: <br/><br/>";

    foreach (DataKey key in CustomerGridView.DataKeys)
    {
       MessageLabel.Text += key.Value.ToString() + "<br/>";
    }
  }
  
</script>

<html>

  <body>
    <form runat="server">
        
      <h3>DataKeyArray Example</h3>
                       
        <asp:gridview id="CustomerGridView"
          datasourceid="CustomerDataSource"
          autogeneratecolumns="true"
          datakeynames="CustomerID"  
          allowpaging="true"
          ondatabound="CustomerGridView_DataBound" 
          runat="server">
            
        </asp:gridview>
        
        <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="CustomerDataSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], [City],
 [PostalCode], [Country] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
          runat="server"/>
            
      </form>
  </body>
</html>

.NET Framework のセキュリティ

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

継承階層

System.Object
  System.Web.UI.WebControls.DataKeyArray

スレッド セーフ

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

参照

関連項目
DataKeyArray メンバ
System.Web.UI.WebControls 名前空間
DataKey クラス
ICollection
IStateManager
CopyTo
GetEnumerator
Item
Count

DataKeyArray コンストラクタ

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

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

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

Visual Basic (宣言)

Public Sub New ( _
    keys As ArrayList _
)

Visual Basic (使用法)

Dim keys As ArrayList

Dim instance As New DataKeyArray(keys)

C#

public DataKeyArray (
    ArrayList keys
)

C++

public:
DataKeyArray (
    ArrayList^ keys
)

J#

public DataKeyArray (
    ArrayList keys
)

JScript

public function DataKeyArray (
    keys : ArrayList
)

パラメータ

keys

コレクションに項目を挿入するために使用する DataKey オブジェクトの ArrayList。

解説

このコンストラクタは、指定した ArrayList オブジェクトを使用して DataKeyArray クラスの新しいインスタンスを初期化するために使用します。ArrayList オブジェクトには、コレクションに項目を挿入するために使用する DataKey オブジェクトが格納されています。

プラットフォーム

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

参照

関連項目
DataKeyArray クラス
DataKeyArray メンバ
System.Web.UI.WebControls 名前空間
DataKey クラス
System.Collections.ArrayList
GridView.DataKeys

DataKeyArray プロパティ

パブリック プロパティ

	名前	説明
	Count	コレクション内の項目の数を取得します。
	IsReadOnly	コレクション内の項目を変更できるかどうかを示す値を取得します。
	IsSynchronized	DataKeyArray コレクションが同期されている (スレッド セーフである) かどうかを示す値を取得します。
	Item	指定したインデックス位置にある DataKey オブジェクトをコレクションから取得します。
	SyncRoot	コレクションへのアクセスを同期するために使用するオブジェクトを取得します。

明示的インターフェイスの実装

	名前	説明
	System.Web.UI.IStateManager.IsTrackingViewState	DataKeyArray オブジェクトがビューステートの変更を追跡しているかどうかを示す値を取得します。

参照

関連項目

DataKeyArray クラス
System.Web.UI.WebControls 名前空間
DataKey クラス
ICollection
IStateManager
CopyTo
GetEnumerator
Item
Count

DataKeyArray メソッド

パブリック メソッド

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

	名前	説明
	CopyTo	指定した DataKey オブジェクトの配列にこのコレクションのすべての項目をコピーします。コピー操作は、配列内の指定したインデックス位置から開始されます。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	コレクション内のすべての DataKey オブジェクトを格納している列挙子を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

明示的インターフェイスの実装

	名前	説明
	System.Collections.ICollection.CopyTo	指定した System.Array にこのコレクションのすべての項目をコピーします。コピー操作は、System.Array 内の指定したインデックス位置から開始されます。
	System.Web.UI.IStateManager.LoadViewState	以前に保存した DataKeyArray オブジェクトのビューステートを読み込みます。
	System.Web.UI.IStateManager.SaveViewState	DataKeyArray オブジェクトの現在のビューステートを保存します。
	System.Web.UI.IStateManager.TrackViewState	DataKeyArray オブジェクトに対するビューステートの変更の追跡と保存を始める開始点にマークを付けます。

参照

関連項目

DataKeyArray クラス
System.Web.UI.WebControls 名前空間
DataKey クラス
ICollection
IStateManager
CopyTo
GetEnumerator
Item
Count

DataKeyArray メンバ

DataKey オブジェクトのコレクションを表します。このクラスは継承できません。

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

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

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

パブリック プロパティ

	名前	説明
	Count	コレクション内の項目の数を取得します。
	IsReadOnly	コレクション内の項目を変更できるかどうかを示す値を取得します。
	IsSynchronized	DataKeyArray コレクションが同期されている (スレッド セーフである) かどうかを示す値を取得します。
	Item	指定したインデックス位置にある DataKey オブジェクトをコレクションから取得します。
	SyncRoot	コレクションへのアクセスを同期するために使用するオブジェクトを取得します。

パブリック メソッド

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

	名前	説明
	CopyTo	指定した DataKey オブジェクトの配列にこのコレクションのすべての項目をコピーします。コピー操作は、配列内の指定したインデックス位置から開始されます。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	コレクション内のすべての DataKey オブジェクトを格納している列挙子を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

明示的インターフェイスの実装

	名前	説明
	System.Collections.ICollection.CopyTo	指定した System.Array にこのコレクションのすべての項目をコピーします。コピー操作は、System.Array 内の指定したインデックス位置から開始されます。
	System.Web.UI.IStateManager.LoadViewState	以前に保存した DataKeyArray オブジェクトのビューステートを読み込みます。
	System.Web.UI.IStateManager.SaveViewState	DataKeyArray オブジェクトの現在のビューステートを保存します。
	System.Web.UI.IStateManager.TrackViewState	DataKeyArray オブジェクトに対するビューステートの変更の追跡と保存を始める開始点にマークを付けます。
	System.Web.UI.IStateManager.IsTrackingViewState	DataKeyArray オブジェクトがビューステートの変更を追跡しているかどうかを示す値を取得します。

参照

関連項目

DataKeyArray クラス
System.Web.UI.WebControls 名前空間
DataKey クラス
ICollection
IStateManager
CopyTo
GetEnumerator
Item
Count