ButtonField.CommandName プロパティとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

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

ButtonField.CommandName プロパティ

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

ButtonField オブジェクトのボタンがクリックされたときに実行されるアクションを表す文字列を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 CommandName As String

Visual Basic (使用法)

Dim instance As ButtonField
Dim value As String

value = instance.CommandName

instance.CommandName = value

public virtual string CommandName { get;
 set; }

C++

public:
virtual property String^ CommandName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_CommandName ()

/** @property */
public void set_CommandName (String value)

JScript

public function get CommandName
 () : String

public function set CommandName
 (value : String)

プロパティ値
ButtonField のボタンがクリックされたときに実行されるアクションの名前。

解説

CommandName プロパティを使用して、"Add" や "Remove" などのコマンド名を、ButtonField オブジェクトのボタンに関連付けます。CommandName プロパティには、コマンドボタンがクリックされたときに実行するアクションを識別する任意の文字列を設定できます。この設定を行うと、イベントハンドラでプログラムによってそのコマンド名を特定し、適切なアクションを実行できます。

メモ
ButtonField オブジェクトのボタンはすべて同じコマンド名を共有します。

データバインドコントロールは、特定のコマンド名を認識すると、そのコントロールの適切なイベントを自動的に発生させて処理します。次のコマンド名が認識されます。

"Cancel"
"Delete"
"Edit"
"Insert"
"New"
"Page"
"Select"
"Sort"
"Update"

ページングを呼び出すには、CommandName に "Page" を設定し、さらに格納されている Button コントロールの CommandArgument に "First"、"Last"、"Prev"、"Next"、またはページ番号を設定します。ただし、ButtonField コントロールの CommandArgument は必ず整数の列インデックスになるので、 ButtonField コントロールはページングの呼び出しには適していません。また、CommandName に "Sort" を設定すると並べ替えを呼び出すことができますが、ButtonField コントロールの CommandArgument プロパティは必ず整数の行インデックスになります。このため、ButtonField コントロールは、並べ替えの呼び出しには適していません。"Add"、"Remove" などのカスタムコマンド名を使用する場合、イベントコードを記述してコマンド名をチェックし、カスタムアクションを実行する必要があります。詳細については、「DataControlCommands」を参照してください。

メモ
注意する必要があるのは、すべてのデータバインドコントロールが、すべてのコマンド名を認識するわけではないということです。たとえば、GridView コントロールは `"New"` を認識しませんし、DetailsView コントロールは `"Select"` を認識しません。

このプロパティの値はビューステートに格納されます。

使用例

CommandName プロパティを使用して、GridView コントロールの ButtonField オブジェクトのボタンのコマンド名を指定する方法を、次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>


<script runat="server">

    Sub CustomersGridView_RowCommand(ByVal
 sender As Object, ByVal
 e As GridViewCommandEventArgs)
  
        ' If multiple ButtonField column fields are used, use the
        ' CommandName property to determine which button was clicked.
        If e.CommandName = "Select"
 Then
    
            ' Convert the row index stored in the CommandArgument
            ' property to an Integer.
            Dim index As Integer
 = Convert.ToInt32(e.CommandArgument)
    
            ' Get the last name of the selected author from the appropriate
            ' cell in the GridView control.
            Dim selectedRow As GridViewRow
 = CustomersGridView.Rows(index)
            Dim contactCell As TableCell =
 selectedRow.Cells(1)
            Dim contact As String
 = contactCell.Text
    
            ' Display the selected author.
            Message.Text = "You selected " & contact
 & "."
      
        End If
    
    End Sub
    
</script>

<html>
  <body>
    <form id="Form1" runat="server">
        
      <h3>ButtonField Example</h3>
      
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
                    
      <!-- Populate the Columns collection declaratively. -->
      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        onrowcommand="CustomersGridView_RowCommand"
        runat="server">
                
        <columns>
                
          <asp:buttonfield buttontype="Button"
 
            commandname="Select"
            headertext="Select Customer" 
            text="Select"/>
          <asp:boundfield datafield="CompanyName"
 
            headertext="Company Name"/>
          <asp:boundfield datafield="ContactName"
 
            headertext="Contact Name"/>
                
        </columns>
                
      </asp:gridview>
            
        <!-- This example uses Microsoft SQL Server and connects
 -->
        <!-- to the Northwind sample database.            
       -->
        <asp:sqldatasource id="CustomersSqlDataSource"
  
          selectcommand="Select [CustomerID], [CompanyName], [ContactName],
 [ContactTitle] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnection%>"
          runat="server">
        </asp:sqldatasource>
            
    </form>
  </body>
</html>

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

<script runat="server">

  void CustomersGridView_RowCommand(Object sender, GridViewCommandEventArgs
 e)
  {
  
    // If multiple ButtonField column fields are used, use the
    // CommandName property to determine which button was clicked.
    if(e.CommandName=="Select")
    {
    
      // Convert the row index stored in the CommandArgument
      // property to an Integer.
      int index = Convert.ToInt32(e.CommandArgument);    
    
      // Get the last name of the selected author from the appropriate
      // cell in the GridView control.
      GridViewRow selectedRow = CustomersGridView.Rows[index];
      TableCell contactName = selectedRow.Cells[1];
      string contact = contactName.Text;  
    
      // Display the selected author.
      Message.Text = "You selected " + contact + ".";
      
    }
    
  }
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>ButtonField Example</h3>
      
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
                    
      <!-- Populate the Columns collection declaratively. -->
      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        onrowcommand="CustomersGridView_RowCommand"
        runat="server">
                
        <columns>
                
          <asp:buttonfield buttontype="Button" 
            commandname="Select"
            headertext="Select Customer" 
            text="Select"/>
          <asp:boundfield datafield="CompanyName" 
            headertext="Company Name"/>
          <asp:boundfield datafield="ContactName" 
            headertext="Contact Name"/>
                
        </columns>
                
      </asp:gridview>
            
        <!-- This example uses Microsoft SQL Server and connects -->
        <!-- to the Northwind sample database.                   -->
        <asp:sqldatasource id="CustomersSqlDataSource"  
          selectcommand="Select [CustomerID], [CompanyName], [ContactName],
 [ContactTitle] From [Customers]"
          connectionstring="<%$ ConnectionStrings:NorthWindConnection%>"
          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

参照

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

このページでは「.NET Framework クラスライブラリリファレンス」からButtonField.CommandName プロパティを検索した結果を表示しています。
Weblioに収録されているすべての辞書からButtonField.CommandName プロパティを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からButtonField.CommandName プロパティを検索

>> 「ButtonField.CommandName プロパティ」を含む用語の索引
ButtonField.CommandName プロパティのページへのリンク

ButtonField.CommandName プロパティとは？わかりやすく解説

ButtonField.CommandName プロパティ

「ButtonField.CommandName プロパティ」の関連用語


	© 2025 Microsoft.All rights reserved.

ButtonField.CommandName プロパティとは？ わかりやすく解説

ButtonField.CommandName プロパティ

急上昇のことば

「ButtonField.CommandName プロパティ」の関連用語

ButtonField.CommandName プロパティとは？わかりやすく解説