ButtonField.CommandName Propriété
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient ou définit une chaîne qui représente l'action à effectuer lorsqu'un clic a été effectué sur le bouton dans un objet 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 StringValeur de propriété
Nom de l'action à exécuter lorsqu'un clic est effectué sur un bouton du ButtonField.
Exemples
L’exemple de code suivant montre comment utiliser la CommandName propriété pour spécifier un nom de commande pour les boutons d’un ButtonField objet d’un GridView contrôle.
<%@ 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>
Remarques
Utilisez la CommandName propriété pour associer un nom de commande, par "Add" exemple, "Remove"aux boutons de l’objet ButtonField . Vous pouvez définir la CommandName propriété sur n’importe quelle chaîne qui identifie l’action à effectuer lorsque le bouton de commande est cliqué. Vous pouvez ensuite déterminer par programmation le nom de la commande dans un gestionnaire d’événements et effectuer les actions appropriées.
Notes
Tous les boutons d’un ButtonField objet partagent le même nom de commande.
Les contrôles liés aux données reconnaissent certains noms de commandes et déclenchent et gèrent automatiquement les événements appropriés pour le contrôle. Les noms de commandes suivants sont reconnus :
"Cancel""Delete""Edit""Insert""New""Page""Select""Sort""Update"
Pour appeler la pagination, définissez la CommandName "Page" valeur et la CommandArgument valeur du contrôle contenu Button sur "First", "Last", "Prev"ou "Next"un numéro de page. Toutefois, étant donné que le CommandArgument ButtonField contrôle est toujours l’index de ligne d’entier, un ButtonField contrôle ne convient pas pour appeler la pagination. De même, bien que vous puissiez appeler le tri en définissant la CommandName "Sort"valeur sur , la CommandArgument propriété d’un ButtonField contrôle est toujours l’index de ligne d’entier. Pour cette raison, un ButtonField contrôle ne convient pas pour appeler le tri. Pour les noms de commandes personnalisés, tels que "Add" et "Remove", vous devez écrire le code d’événement pour vérifier le nom de la commande et effectuer une action personnalisée. Pour plus d'informations, consultez DataControlCommands.
Notes
Tous les noms de commandes ne sont pas reconnus par tous les contrôles liés aux données. Par exemple, "New" n’est pas reconnu par le GridView contrôle et "Select" n’est pas reconnu par le DetailsView contrôle.
La valeur de cette propriété est stockée dans l’état d’affichage.