ButtonField.CommandName Propriedade
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Recebe ou define uma cadeia que representa a ação a realizar quando um botão num ButtonField objeto é clicado.
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 StringValor de Propriedade
O nome da ação a realizar quando um botão ButtonField no é clicado.
Exemplos
O exemplo de código seguinte demonstra como usar a CommandName propriedade para especificar um nome de comando para os botões num ButtonField objeto de um GridView controlo.
<%@ 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>
Observações
Use a CommandName propriedade para associar um nome de comando, como "Add" ou "Remove", aos botões no ButtonField objeto. Podes definir a CommandName propriedade para qualquer string que identifique a ação a executar quando o botão de comando é clicado. Pode então determinar programaticamente o nome do comando num gestor de eventos e executar as ações apropriadas.
Note
Todos os botões de um ButtonField objeto partilham o mesmo nome de comando.
Os controlos vinculados a dados reconhecem certos nomes de comandos e automaticamente levantam e gerem os eventos apropriados para o controlo. Os seguintes nomes de comandos são reconhecidos:
"Cancel""Delete""Edit""Insert""New""Page""Select""Sort""Update"
Para invocar a paginação, defina o CommandName para e o CommandArgument do controlo contido Button para "First", "Last", "Prev", "Next", ou um "Page" número de página. No entanto, como o CommandArgument para um ButtonField controlo é sempre o índice inteiro da linha, um ButtonField controlo não é adequado para invocar paginação. De forma semelhante, embora se possa invocar a ordenação definindo o CommandName para , a CommandArgument propriedade de um ButtonField controlo é sempre o índice "Sort"inteiro da linha. Por esta razão, um ButtonField controlo não é adequado para invocar ordenação. Para nomes de comandos personalizados, como "Add" e "Remove", é necessário escrever o código do evento para verificar o nome do comando e realizar alguma ação personalizada. Para obter mais informações, veja DataControlCommands.
Note
Nem todos os nomes de comandos são reconhecidos por todos os controlos data-bound. Por exemplo, "New" não é reconhecido pelo GridView controlo e "Select" não é reconhecido pelo DetailsView controlo.
O valor desta propriedade é armazenado no estado de visualização.