ButtonField Classe
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.
Représente un champ affiché sous la forme d’un bouton dans un contrôle lié aux données.
public ref class ButtonField : System::Web::UI::WebControls::ButtonFieldBase
public class ButtonField : System.Web.UI.WebControls.ButtonFieldBase
type ButtonField = class
inherit ButtonFieldBase
Public Class ButtonField
Inherits ButtonFieldBase
- Héritage
Exemples
L’exemple de code suivant montre comment utiliser un ButtonField objet pour afficher une colonne de boutons de commande dans 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
La ButtonField classe est utilisée par les contrôles liés aux données (tels que GridView et DetailsView) pour afficher un bouton pour chaque enregistrement affiché. L’objet ButtonField est affiché différemment en fonction du contrôle lié aux données dans lequel il est utilisé. Par exemple, le GridView contrôle affiche un ButtonField objet sous forme de colonne, tandis que le DetailsView contrôle l’affiche sous forme de ligne.
Cliquer sur un bouton dans un champ de bouton déclenche l’événement de commande du contrôle parent lié aux données. Vous pouvez fournir une routine personnalisée à effectuer lorsqu’un bouton de commande est cliqué en fournissant un gestionnaire d’événements pour l’événement de commande.
Note
Le GridView contrôle déclenche l’événement RowCommand , tandis que le DetailsView contrôle déclenche l’événement ItemCommand .
Pour déterminer l’index de l’enregistrement qui déclenche l’événement de commande, utilisez la CommandArgument propriété de l’argument d’événement passé à l’événement de commande pour le contrôle lié aux données. La ButtonField classe remplit automatiquement la CommandArgument propriété avec la valeur d’index appropriée.
Pour spécifier le type de bouton à afficher, utilisez la ButtonType propriété. Lorsque vous affichez un lien ou un bouton de commande, utilisez la Text propriété pour spécifier la légende à afficher dans les boutons.
Note
Si vous définissez la Text propriété, tous les boutons d’un ButtonField partage de la même légende.
Vous pouvez également lier l’objet ButtonField à un champ dans une source de données. Cela vous permet d’afficher différentes légendes pour les boutons de l’objet ButtonField . Les valeurs figurant dans le champ spécifié sont utilisées pour les légendes de texte des boutons. Définissez la DataTextField propriété pour lier un ButtonField objet à un champ dans une source de données.
Lorsque vous affichez un bouton image, utilisez la ImageUrl propriété pour spécifier l’image à afficher pour les boutons de l’objet ButtonField .
Note
Tous les boutons d’un ButtonField objet partagent la même image.
Vous pouvez masquer un ButtonField objet dans un contrôle lié aux données en définissant la propriété sur falseVisible .
L’objet ButtonField vous permet de personnaliser ses sections d’en-tête et de pied de page. Pour afficher une légende dans la section en-tête ou pied de page, définissez respectivement les propriétés ou FooterText l’en-têteHeaderText. Au lieu d’afficher du texte dans la section d’en-tête, vous pouvez afficher une image en définissant la HeaderImageUrl propriété. Pour masquer la section d’en-tête dans un ButtonField objet, définissez la ShowHeader propriété falsesur .
Note
Certains contrôles liés aux données (tels que le GridView contrôle) peuvent afficher ou masquer uniquement la section d’en-tête entière du contrôle. Ces contrôles liés aux données ne prennent pas en charge la ShowHeader propriété d’un champ de bouton individuel. Pour afficher ou masquer l’intégralité de la section d’en-tête d’un contrôle lié aux données (le cas échéant), utilisez la ShowHeader propriété pour le contrôle.
Vous pouvez également personnaliser l’apparence de l’objet ButtonField (couleur de police, couleur d’arrière-plan, et ainsi de suite) en définissant les propriétés de style pour les différentes parties du champ. Le tableau suivant répertorie les différentes propriétés de style.
| Style, propriété | Paramètres de style pour |
|---|---|
| ControlStyle | Contrôles de serveur web enfant de l’objet ButtonField. |
| FooterStyle | Section pied de page du ButtonField. |
| HeaderStyle | Section d’en-tête du ButtonField. |
| ItemStyle | Éléments de données dans le ButtonField. |
Constructeurs
| Nom | Description |
|---|---|
| ButtonField() |
Initialise une nouvelle instance de la classe ButtonField. |
Propriétés
| Nom | Description |
|---|---|
| AccessibleHeaderText |
Obtient ou définit le |
| ButtonType |
Obtient ou définit le type de bouton à afficher dans le champ de bouton. (Hérité de ButtonFieldBase) |
| CausesValidation |
Obtient ou définit une valeur indiquant si la validation est effectuée lorsqu’un bouton d’un ButtonFieldBase objet est cliqué. (Hérité de ButtonFieldBase) |
| CommandName |
Obtient ou définit une chaîne qui représente l’action à effectuer lorsqu’un bouton d’un ButtonField objet est cliqué. |
| Control |
Obtient une référence au contrôle de données auquel l’objet DataControlField est associé. (Hérité de DataControlField) |
| ControlStyle |
Obtient le style de tous les contrôles de serveur Web contenus par l’objet DataControlField . (Hérité de DataControlField) |
| DataTextField |
Obtient ou définit le nom du champ de données pour lequel la valeur est liée à la Text propriété du Button contrôle rendu par l’objet ButtonField . |
| DataTextFormatString |
Obtient ou définit la chaîne qui spécifie le format d’affichage de la valeur du champ. |
| DesignMode |
Obtient une valeur indiquant si un champ de contrôle de données est actuellement consulté dans un environnement au moment du design. (Hérité de DataControlField) |
| FooterStyle |
Obtient ou définit le style du pied de page du champ de contrôle de données. (Hérité de DataControlField) |
| FooterText |
Obtient ou définit le texte affiché dans l’élément de pied de page d’un champ de contrôle de données. (Hérité de DataControlField) |
| HeaderImageUrl |
Obtient ou définit l’URL d’une image affichée dans l’élément d’en-tête d’un champ de contrôle de données. (Hérité de DataControlField) |
| HeaderStyle |
Obtient ou définit le style de l’en-tête du champ de contrôle de données. (Hérité de DataControlField) |
| HeaderText |
Obtient ou définit le texte affiché dans l’élément d’en-tête d’un champ de contrôle de données. (Hérité de DataControlField) |
| ImageUrl |
Obtient ou définit l’image à afficher pour chaque bouton de l’objet ButtonField . |
| InsertVisible |
Obtient une valeur indiquant si l’objet DataControlField est visible lorsque son contrôle parent lié aux données est en mode d’insertion. (Hérité de DataControlField) |
| IsTrackingViewState |
Obtient une valeur indiquant si l’objet DataControlField enregistre les modifications apportées à son état d’affichage. (Hérité de DataControlField) |
| ItemStyle |
Obtient le style d’un contenu textuel affiché par un champ de contrôle de données. (Hérité de DataControlField) |
| ShowHeader |
Obtient ou définit une valeur indiquant si la section d’en-tête est affichée dans un ButtonFieldBase objet. (Hérité de ButtonFieldBase) |
| SortExpression |
Obtient ou définit une expression de tri utilisée par un contrôle de source de données pour trier les données. (Hérité de DataControlField) |
| Text |
Obtient ou définit la légende statique affichée pour chaque bouton de l’objet ButtonField . |
| ValidateRequestMode |
Obtient ou définit une valeur qui spécifie si le contrôle valide l’entrée du client. (Hérité de DataControlField) |
| ValidationGroup |
Obtient ou définit le nom du groupe de contrôles de validation à valider lorsqu’un bouton d’un ButtonFieldBase objet est cliqué. (Hérité de ButtonFieldBase) |
| ViewState |
Obtient un dictionnaire d’informations d’état qui vous permet d’enregistrer et de restaurer l’état d’affichage d’un DataControlField objet sur plusieurs requêtes pour la même page. (Hérité de DataControlField) |
| Visible |
Obtient ou définit une valeur indiquant si un champ de contrôle de données est rendu. (Hérité de DataControlField) |
Méthodes
| Nom | Description |
|---|---|
| CloneField() |
Crée une copie en double de l’objet dérivé actuel DataControlField. (Hérité de DataControlField) |
| CopyProperties(DataControlField) |
Copie les propriétés de l’objet actif ButtonField vers l’objet spécifié DataControlField . |
| CreateField() |
Crée et retourne une nouvelle instance de la ButtonField classe. |
| Equals(Object) |
Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object) |
| ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean) |
Extrait la valeur du champ de contrôle de données de la cellule de table active et ajoute la valeur à la collection spécifiée IDictionary . (Hérité de DataControlField) |
| FormatDataTextValue(Object) |
Met en forme la valeur de champ spécifiée pour une cellule de l’objet ButtonField . |
| GetHashCode() |
Sert de fonction de hachage par défaut. (Hérité de Object) |
| GetType() |
Obtient la Type de l’instance actuelle. (Hérité de Object) |
| Initialize(Boolean, Control) |
Initialise l’objet actuel ButtonField . |
| InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32) |
Initialise l’objet spécifié DataControlFieldCell à l’état de ligne spécifié. |
| LoadViewState(Object) |
Restaure l’état d’affichage précédemment enregistré de la vue de source de données. (Hérité de DataControlField) |
| MemberwiseClone() |
Crée une copie superficielle du Objectactuel. (Hérité de Object) |
| OnFieldChanged() |
Déclenche l’événement |
| SaveViewState() |
Enregistre les modifications apportées à l’état DataControlField d’affichage depuis la publication de la page sur le serveur. (Hérité de DataControlField) |
| ToString() |
Retourne une chaîne qui représente cet DataControlField objet. (Hérité de DataControlField) |
| TrackViewState() |
Provoque le DataControlField suivi des modifications apportées à son état d’affichage afin qu’ils puissent être stockés dans la propriété du ViewState contrôle et conservés dans les requêtes pour la même page. (Hérité de DataControlField) |
| ValidateSupportsCallback() |
Détermine si les contrôles contenus dans un ButtonField objet prennent en charge les rappels. |
Implémentations d’interfaces explicites
| Nom | Description |
|---|---|
| IDataSourceViewSchemaAccessor.DataSourceViewSchema |
Obtient ou définit le schéma associé à cet DataControlField objet. (Hérité de DataControlField) |
| IStateManager.IsTrackingViewState |
Obtient une valeur indiquant si l’objet DataControlField enregistre les modifications apportées à son état d’affichage. (Hérité de DataControlField) |
| IStateManager.LoadViewState(Object) |
Restaure l’état d’affichage précédemment enregistré du champ de contrôle de données. (Hérité de DataControlField) |
| IStateManager.SaveViewState() |
Enregistre les modifications apportées à l’état DataControlField d’affichage depuis la publication de la page sur le serveur. (Hérité de DataControlField) |
| IStateManager.TrackViewState() |
Provoque le DataControlField suivi des modifications apportées à son état d’affichage afin qu’ils puissent être stockés dans la propriété du ViewState contrôle et conservés dans les requêtes pour la même page. (Hérité de DataControlField) |