ButtonField.CommandName Propiedad
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Obtiene o establece una cadena que representa la acción que se ejecuta al hacer clic en un botón del objeto 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 StringValor de propiedad
El nombre de la acción que se realiza cuando se hace clic en un botón de ButtonField.
Ejemplos
En el ejemplo de código siguiente se muestra cómo usar la CommandName propiedad para especificar un nombre de comando para los botones de un ButtonField objeto de un GridView control.
<%@ 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>
Comentarios
Utilice la CommandName propiedad para asociar un nombre de comando, como "Add" o "Remove", con los botones del ButtonField objeto . Puede establecer la CommandName propiedad en cualquier cadena que identifique la acción que se va a realizar cuando se haga clic en el botón de comando. A continuación, puede determinar mediante programación el nombre del comando en un controlador de eventos y realizar las acciones adecuadas.
Nota
Todos los botones de un ButtonField objeto comparten el mismo nombre de comando.
Los controles enlazados a datos reconocen determinados nombres de comando y generan y controlan automáticamente los eventos adecuados para el control. Se reconocen los siguientes nombres de comando:
"Cancel""Delete""Edit""Insert""New""Page""Select""Sort""Update"
Para invocar la paginación, establezca en "Page" CommandName y el CommandArgument del control contenido Button en "First", "Last", "Prev", "Next"o un número de página. Sin embargo, dado que para CommandArgument un ButtonField control siempre es el índice de fila entera, un ButtonField control no es adecuado para invocar la paginación. Del mismo modo, aunque puede invocar la ordenación estableciendo en CommandName "Sort", la CommandArgument propiedad de un ButtonField control siempre es el índice de fila entero. Por este motivo, un ButtonField control no es adecuado para invocar la ordenación. Para los nombres de comandos personalizados, como "Add" y "Remove", debe escribir el código de evento para comprobar el nombre del comando y realizar alguna acción personalizada. Para obtener más información, vea DataControlCommands.
Nota
No todos los nombres de comando se reconocen mediante todos los controles enlazados a datos. Por ejemplo, "New" el GridView control no reconoce y "Select" el DetailsView control no lo reconoce.
El valor de esta propiedad se almacena en estado de vista.