ButtonField.CommandName プロパティ
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ButtonField オブジェクトのボタンがクリックされたときに実行されるアクションを表す文字列を取得または設定します。
public:
virtual property System::String ^ CommandName { System::String ^ get(); void set(System::String ^ value); };public virtual string CommandName { get; set; }member this.CommandName : string with get, setPublic Overridable Property CommandName As Stringプロパティ値
ButtonField のボタンがクリックされたときに実行されるアクションの名前。
例
次のコード例では、 プロパティを CommandName 使用して、コントロールのオブジェクト内のボタンのコマンド名を ButtonField 指定する方法を GridView 示します。
<%@ Page language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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 xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ButtonField Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>ButtonField Example</h3>
<asp:label id="Message"
forecolor="Red"
runat="server"
AssociatedControlID="CustomersGridView"/>
<!-- 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="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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 xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ButtonField Example</title>
</head>
<body>
<form id="Form1" runat="server">
<h3>ButtonField Example</h3>
<asp:label id="Message"
forecolor="Red"
runat="server"
AssociatedControlID="CustomersGridView"/>
<!-- 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>
注釈
プロパティをCommandName使用して、 や "Remove"などの"Add"コマンド名を オブジェクト内のボタンにButtonField関連付けます。 プロパティは CommandName 、コマンド ボタンがクリックされたときに実行するアクションを識別する任意の文字列に設定できます。 その後、イベント ハンドラーでコマンド名をプログラムで決定し、適切なアクションを実行できます。
注意
オブジェクト内のすべてのボタンは、 ButtonField 同じコマンド名を共有します。
データ バインド コントロールは、特定のコマンド名を認識し、コントロールの適切なイベントを自動的に発生および処理します。 次のコマンド名が認識されます。
"Cancel""Delete""Edit""Insert""New""Page""Select""Sort""Update"
ページングを呼び出すには、 を に"Page"設定し、含まれているButtonコントロール"First"の を CommandArgument 、、"Last""Prev"、"Next"、またはページ番号に設定CommandNameします。 ただし、コントロールの ButtonField は常に整数行インデックスであるためCommandArgument、ページングのButtonField呼び出しには、コントロールは適していません。 同様に、 を に"Sort"設定CommandNameすることで並べ替えを呼び出すことができますが、コントロールの CommandArgumentButtonField プロパティは常に整数行インデックスです。 このため、 ButtonField コントロールは並べ替えの呼び出しには適していません。 や "Remove"などの"Add"カスタム コマンド名の場合は、イベント コードを記述してコマンド名を確認し、カスタム アクションを実行する必要があります。 詳細については、「DataControlCommands」を参照してください。
注意
すべてのコマンド名が、すべてのデータ バインド コントロールによって認識されるわけではありません。 たとえば、 "New" はコントロールによって GridView 認識されず、 "Select" コントロールによって DetailsView 認識されません。
このプロパティの値はビュー ステートに格納されます。
適用対象
.NET