CommandField クラスとは何？わかりやすく解説 Weblio辞書

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

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

CommandField クラス

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

データバインドコントロールで選択、編集、挿入、または削除の各操作を実行するコマンドボタンを表示する、特殊なフィールドを表します。

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

Visual Basic (宣言)

Public Class CommandField
    Inherits ButtonFieldBase

Visual Basic (使用法)

Dim instance As CommandField

public class CommandField : ButtonFieldBase

C++

public ref class CommandField : public
 ButtonFieldBase

public class CommandField extends ButtonFieldBase

JScript

public class CommandField extends
 ButtonFieldBase

解説

CommandField クラスは、データバインドコントロール (GridView および DetailsView など) で使用される特殊なフィールドで、削除、編集、挿入、または選択の各操作を実行するコマンドボタンを表示します。これらの操作を実行するコマンドボタンは、次の表に示すプロパティを使用して表示または非表示にできます。

プロパティ

説明

ShowDeleteButton

データバインドコントロール内のレコードごとに、CommandField フィールドの Delete ボタンを表示または非表示にします。Delete ボタンを使用すると、ユーザーはデータソースからレコードを削除できます。

ShowEditButton

データバインドコントロール内のレコードごとに、CommandField フィールドの Edit ボタンを表示または非表示にします。Edit ボタンを使用すると、ユーザーはデータソースのレコードを編集できます。ユーザーが特定のレコードの Edit ボタンをクリックすると、Edit ボタンは Update ボタンと Cancel ボタンに置き換わります。その他のコマンドボタンもすべて非表示になります。

ShowInsertButton

CommandField フィールドの New ボタンを表示または非表示にします。New ボタンを使用すると、ユーザーはデータソースに新しいレコードを挿入できます。ユーザーが New ボタンをクリックすると、Insert ボタンと Cancel ボタンに置き換わります。その他のコマンドボタンもすべて非表示になります。

メモ
このプロパティは、DetailsView コントロールなど、挿入操作をサポートしたデータバインドコントロールにのみ適用されます。

ShowSelectButton

データバインドコントロール内のレコードごとに、CommandField フィールドの Select ボタンを表示または非表示にします。Select ボタンを使用すると、ユーザーはデータバインドコントロール内のレコードを選択できます。

また、ShowCancelButton プロパティを設定することにより、レコードが編集モードまたは挿入モードのときに表示される Cancel ボタンを表示または非表示にすることもできます。

メモ
データバインドコントロールをデータソースコントロール (SqlDataSource コントロールなど) と組み合わせて使用すると、データバインドコントロールはデータソースコントロールの機能を利用して、削除、更新、および挿入の自動実行機能を提供できます。その他のデータソースの場合、データバインドコントロールの適切なイベント中にこれらの操作を実行するためにルーチンを提供する必要があります。

メモ

データバインドコントロールをデータソースコントロール (SqlDataSource コントロールなど) と組み合わせて使用すると、データバインドコントロールはデータソースコントロールの機能を利用して、削除、更新、および挿入の自動実行機能を提供できます。その他のデータソースの場合、データバインドコントロールの適切なイベント中にこれらの操作を実行するためにルーチンを提供する必要があります。

CommandField フィールドは、それが使用されているデータバインドコントロールによって表示が異なります。たとえば、CommandField フィールドは、GridView コントロールでは列として表示され、DetailsView コントロールでは行として表示されます。

表示するボタンの種類を指定するには、ButtonType プロパティを使用します。ButtonType プロパティが ButtonType.Button または ButtonType.Link に設定されている場合、次の表に示すプロパティを設定して、ボタンに表示するテキストを指定できます。

CancelText

DeleteText

EditText

InsertText

メモ
このプロパティは、DetailsView コントロールなど、挿入操作をサポートしたデータバインドコントロールにのみ適用されます。

NewText

New ボタンのキャプション。

メモ
このプロパティは、DetailsView コントロールなど、挿入操作をサポートしたデータバインドコントロールにのみ適用されます。

SelectText

Select ボタンのキャプション。

UpdateText

Update ボタンのキャプション。

コマンドボタンまたはリンクボタンを表示する代わりに、ButtonType プロパティを ButtonType.Image に設定し、次の表に示すプロパティを設定して、イメージボタンを表示できます。

プロパティ

説明

CancelImageUrl

Cancel ボタンに表示されるイメージ。

DeleteImageUrl

Delete ボタンに表示されるイメージ。

EditImageUrl

Edit ボタンに表示されるイメージ。

InsertText

Insert ボタンに表示されるイメージ。

メモ
このプロパティは、DetailsView コントロールなど、挿入操作をサポートしたデータバインドコントロールにのみ適用されます。

NewImageUrl

New ボタンに表示されるイメージ。

メモ
このプロパティは、DetailsView コントロールなど、挿入操作をサポートしたデータバインドコントロールにのみ適用されます。

SelectImageUrl

Select ボタンに表示されるイメージ。

UpdateImageUrl

Update ボタンに表示されるイメージ。

既定では、ユーザーが CommandField フィールドでボタンをクリックすると、ページのすべての検証コントロールで検証が実行されます。ボタンをクリックしたときに検証が行われないようにするには、CausesValidation プロパティを false に設定します。

Visible プロパティを false に設定すると、データバインドコントロールの CommandField フィールドを非表示にできます。

CommandField フィールドを使用すると、ヘッダーセクションおよびフッターセクションをカスタマイズできます。ヘッダーセクションまたはフッターセクションにキャプションを表示するには、HeaderText プロパティまたは FooterText プロパティをそれぞれ設定します。ヘッダーセクションにテキストを表示する代わりに、HeaderImageUrl プロパティを設定してイメージを表示できます。CommandField オブジェクトのヘッダーセクションを非表示にするには、ShowHeader プロパティを false に設定します。

メモ
一部のデータバインドコントロール (GridView コントロールなど) では、コントロールのヘッダーセクション全体を表示または非表示にできます。これらのデータバインドコントロールは、個別のボタンフィールドの ShowHeader プロパティをサポートしていません。データバインドコントロールのヘッダーセクション (存在する場合) 全体を表示または非表示にするには、コントロールの ShowHeader プロパティを使用します。

メモ

一部のデータバインドコントロール (GridView コントロールなど) では、コントロールのヘッダーセクション全体を表示または非表示にできます。これらのデータバインドコントロールは、個別のボタンフィールドの ShowHeader プロパティをサポートしていません。データバインドコントロールのヘッダーセクション (存在する場合) 全体を表示または非表示にするには、コントロールの ShowHeader プロパティを使用します。

フィールドの各部分にスタイルプロパティを設定することにより、CommandField オブジェクトの外観 (フォントの色や背景色など) をカスタマイズすることもできます。さまざまなスタイルプロパティの一覧を次の表に示します。

スタイルプロパティ	説明
ControlStyle	CommandField オブジェクトの子 Web サーバーコントロールのスタイル設定。
FooterStyle	CommandField オブジェクトのフッターセクションのスタイル設定。
HeaderStyle	CommandField オブジェクトのヘッダーセクションのスタイル設定。
ItemStyle	CommandField オブジェクトのデータ項目のスタイル設定。

使用例

CommandField フィールドを使用してコントロールを表示し、GridView コントロール内のレコードを編集する方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

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

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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

CancelText、EditText、および UpdateText の各プロパティを使用して、編集コントロールのテキストをカスタマイズする方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            edittext="Edit Customer"
            canceltext="Discard"
            updatetext="Revise"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

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

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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            edittext="Edit Customer"
            canceltext="Discard"
            updatetext="Revise"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </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)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

.NET Framework のセキュリティ

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

継承階層

System.Object
   System.Web.UI.WebControls.DataControlField
     System.Web.UI.WebControls.ButtonFieldBase
      System.Web.UI.WebControls.CommandField

スレッドセーフ

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

参照

関連項目
CommandField メンバ
System.Web.UI.WebControls 名前空間
GridView
Columns
DetailsView
Fields
BoundField クラス
ButtonField クラス
ButtonFieldBase クラス
CheckBoxField クラス
DataControlField
HyperLinkField
TemplateField
ButtonFieldBase.ButtonType プロパティ
CancelText
DeleteImageUrl
DeleteText
EditImageUrl
EditText
InsertImageUrl
InsertText
NewImageUrl
NewText
SelectImageUrl
SelectText
ShowCancelButton
ShowDeleteButton
ShowEditButton
ShowInsertButton
ShowSelectButton
UpdateImageUrl
UpdateText
ControlStyle
FooterStyle
HeaderStyle
ItemStyle

>> 「CommandField クラス」を含む用語の索引
CommandField クラスのページへのリンク

CommandField クラスとは？わかりやすく解説