GridView.DataKeyNames プロパティ

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

GridView.DataKeyNames プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

GridView コントロールに表示される項目の主キー フィールドの名前が格納された配列を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 DataKeyNames As String()

Visual Basic (使用法)

Dim instance As GridView
Dim value As String()

value = instance.DataKeyNames

instance.DataKeyNames = value

C#

public virtual string[] DataKeyNames { get;
 set; }

C++

public:
virtual property array<String^>^ DataKeyNames {
    array<String^>^ get ();
    void set (array<String^>^ value);
}

J#

/** @property */
public String[] get_DataKeyNames ()

/** @property */
public void set_DataKeyNames (String[] value)

JScript

public function get DataKeyNames
 () : String[]

public function set DataKeyNames
 (value : String[])

プロパティ値
GridView コントロールに表示される項目の主キー フィールドの名前が格納された配列。

解説

DataKeyNames プロパティを使用して、データ ソースの主キーを表す 1 つ以上のフィールドを指定します。

メモ
宣言によってこのプロパティを設定するには、フィールド名のコンマ区切りのリストを使用します。

DataKeyNames プロパティが設定されている場合、GridView コントロールは、指定した 1 つ以上のフィールドの値を自動的に DataKeys コレクションに読み込みます。これにより、各行の主キーに簡単にアクセスできます。

メモ
GridView コントロールでは、これらのキー フィールド値がコントロールの状態に格納されます。これらの値に機密情報が含まれている場合は、ViewStateEncryptionMode プロパティを ViewStateEncryptionMode.Always に設定して、ビューステートの暗号化を有効にするようにしてください。

(AutoGenerateColumns プロパティを true に設定することによって) 自動生成されたフィールド列を使用する場合、GridView コントロールは、DataKeyNames プロパティで指定された 1 つ以上のフィールドに対応する自動生成されたフィールド列が読み取り専用であるかどうかを自動的に確認します。

メモ
GridView コントロールの自動更新機能と自動削除機能が動作するようにするには、DataKeyNames プロパティを設定する必要があります。これらのキー フィールドの値は、更新または削除する行を一致させるために、データ ソース コントロールに渡されます。

列フィールドの Visible プロパティが false に設定されている場合、その列は GridView コントロールに表示されず、列のデータはクライアントへのラウンド トリップを行いません。表示されない列のデータをラウンド トリップさせる場合は、そのフィールド名を DataKeyNames プロパティに追加します。

Topic	Location
チュートリアル : XML データを表示する Web ページの作成	Visual Studio での ASP .NET Web アプリケーションの作成
チュートリアル : 変換による Web フォーム ページへの XML ドキュメントの表示	Visual Studio での ASP .NET Web アプリケーションの作成

使用例

DataKeyNames プロパティを使用して、データ ソースのキー フィールドを指定する方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView Edit Example</h3>

      <!-- The GridView control automatically sets the columns     -->
      <!-- specified in the datakeynames property
 as read-only.    -->
      <!-- No input controls are rendered for these columns
 in     -->
      <!-- edit mode.                                              -->
      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="true"
        autogeneratedeletebutton="true"
        autogenerateeditbutton="true"
        datakeynames="CustomerID"  
        runat="server">
      </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="CustomersSqlDataSource"
  
        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)"
        deletecommand="Delete from Customers where CustomerID
 = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

C#

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

<html>
  <body>
    <form runat="server">
        
      <h3>GridView Edit Example</h3>

      <!-- The GridView control automatically sets the columns     -->
      <!-- specified in the datakeynames property as read-only.
    -->
      <!-- No input controls are rendered for these columns
 in     -->
      <!-- edit mode.                                              -->
      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="true"
        autogeneratedeletebutton="true"
        autogenerateeditbutton="true"
        datakeynames="CustomerID"  
        runat="server">
      </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="CustomersSqlDataSource"  
        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)"
        deletecommand="Delete from Customers where CustomerID = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

プラットフォーム

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

参照

関連項目
GridView クラス
GridView メンバ
System.Web.UI.WebControls 名前空間
DataKey クラス
DataKeyArray クラス
GridView.AutoGenerateEditButton プロパティ
GridView.AutoGenerateDeleteButton プロパティ
DataKeys