EditCommandColumn 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.
Type de colonne spécial pour le contrôle DataGrid contenant les boutons Edit permettant de modifier des éléments de données dans chaque ligne.
public ref class EditCommandColumn : System::Web::UI::WebControls::DataGridColumnpublic class EditCommandColumn : System.Web.UI.WebControls.DataGridColumntype EditCommandColumn = class
inherit DataGridColumnPublic Class EditCommandColumn
Inherits DataGridColumn- Héritage
Exemples
L’exemple de code suivant montre comment ajouter un EditCommandColumn objet à un DataGrid contrôle.
<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<script runat="server">
// The Cart and CartView objects temporarily store the data source
// for the DataGrid control while the page is being processed.
DataTable Cart = new DataTable();
DataView CartView;
void Page_Load(Object sender, EventArgs e)
{
// With a database, use an select query to retrieve the data. Because
// the data source in this example is an in-memory DataTable, retrieve
// the data from session state if it exists; otherwise, create the data
// source.
GetSource();
// The DataGrid control maintains state between posts to the server;
// it only needs to be bound to a data source the first time the page
// is loaded or when the data source is updated.
if (!IsPostBack)
{
BindGrid();
}
}
void ItemsGrid_Edit(Object sender, DataGridCommandEventArgs e)
{
// Set the EditItemIndex property to the index of the item clicked
// in the DataGrid control to enable editing for that item. Be sure
// to rebind the DateGrid to the data source to refresh the control.
ItemsGrid.EditItemIndex = e.Item.ItemIndex;
BindGrid();
}
void ItemsGrid_Cancel(Object sender, DataGridCommandEventArgs e)
{
// Set the EditItemIndex property to -1 to exit editing mode.
// Be sure to rebind the DateGrid to the data source to refresh
// the control.
ItemsGrid.EditItemIndex = -1;
BindGrid();
}
void ItemsGrid_Update(Object sender, DataGridCommandEventArgs e)
{
// Retrieve the text boxes that contain the values to update.
// For bound columns, the edited value is stored in a TextBox.
// The TextBox is the 0th control in a cell's Controls collection.
// Each cell in the Cells collection of a DataGrid item represents
// a column in the DataGrid control.
TextBox qtyText = (TextBox)e.Item.Cells[3].Controls[0];
TextBox priceText = (TextBox)e.Item.Cells[4].Controls[0];
// Retrieve the updated values.
String item = e.Item.Cells[2].Text;
String qty = qtyText.Text;
String price = priceText.Text;
DataRow dr;
// With a database, use an update command to update the data.
// Because the data source in this example is an in-memory
// DataTable, delete the old row and replace it with a new one.
// Remove the old entry and clear the row filter.
CartView.RowFilter = "Item='" + item + "'";
if (CartView.Count > 0)
{
CartView.Delete(0);
}
CartView.RowFilter = "";
// ***************************************************************
// Insert data validation code here. Be sure to validate the
// values entered by the user before converting to the appropriate
// data types and updating the data source.
// ***************************************************************
// Add the new entry.
dr = Cart.NewRow();
dr[0] = Convert.ToInt32(qty);
dr[1] = item;
// If necessary, remove the '$' character from the price before
// converting it to a Double.
if(price[0] == '$')
{
dr[2] = Convert.ToDouble(price.Substring(1));
}
else
{
dr[2] = Convert.ToDouble(price);
}
Cart.Rows.Add(dr);
// Set the EditItemIndex property to -1 to exit editing mode.
// Be sure to rebind the DateGrid to the data source to refresh
// the control.
ItemsGrid.EditItemIndex = -1;
BindGrid();
}
void BindGrid()
{
// Set the data source and bind to the Data Grid control.
ItemsGrid.DataSource = CartView;
ItemsGrid.DataBind();
}
void GetSource()
{
// For this example, the data source is a DataTable that is stored
// in session state. If the data source does not exist, create it;
// otherwise, load the data.
if (Session["ShoppingCart"] == null)
{
// Create the sample data.
DataRow dr;
// Define the columns of the table.
Cart.Columns.Add(new DataColumn("Qty", typeof(Int32)));
Cart.Columns.Add(new DataColumn("Item", typeof(String)));
Cart.Columns.Add(new DataColumn("Price", typeof(Double)));
// Store the table in session state to persist its values
// between posts to the server.
Session["ShoppingCart"] = Cart;
// Populate the DataTable with sample data.
for (int i = 1; i <= 9; i++)
{
dr = Cart.NewRow();
if (i % 2 != 0)
{
dr[0] = 2;
}
else
{
dr[0] = 1;
}
dr[1] = "Item " + i.ToString();
dr[2] = (1.23 * (i + 1));
Cart.Rows.Add(dr);
}
}
else
{
// Retrieve the sample data from session state.
Cart = (DataTable)Session["ShoppingCart"];
}
// Create a DataView and specify the field to sort by.
CartView = new DataView(Cart);
CartView.Sort="Item";
return;
}
void ItemsGrid_Command(Object sender, DataGridCommandEventArgs e)
{
switch(((LinkButton)e.CommandSource).CommandName)
{
case "Delete":
DeleteItem(e);
break;
// Add other cases here, if there are multiple ButtonColumns in
// the DataGrid control.
default:
// Do nothing.
break;
}
}
void DeleteItem(DataGridCommandEventArgs e)
{
// e.Item is the table row where the command is raised. For bound
// columns, the value is stored in the Text property of a TableCell.
TableCell itemCell = e.Item.Cells[2];
string item = itemCell.Text;
// Remove the selected item from the data source.
CartView.RowFilter = "Item='" + item + "'";
if (CartView.Count > 0)
{
CartView.Delete(0);
}
CartView.RowFilter = "";
// Rebind the data source to refresh the DataGrid control.
BindGrid();
}
</script>
<head runat="server">
<title>DataGrid Editing Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DataGrid Editing Example</h3>
<asp:DataGrid id="ItemsGrid"
BorderColor="black"
BorderWidth="1"
CellPadding="3"
OnEditCommand="ItemsGrid_Edit"
OnCancelCommand="ItemsGrid_Cancel"
OnUpdateCommand="ItemsGrid_Update"
OnItemCommand="ItemsGrid_Command"
AutoGenerateColumns="false"
runat="server">
<HeaderStyle BackColor="#aaaadd">
</HeaderStyle>
<Columns>
<asp:EditCommandColumn
EditText="Edit"
CancelText="Cancel"
UpdateText="Update"
HeaderText="Edit item">
<ItemStyle Wrap="False">
</ItemStyle>
<HeaderStyle Wrap="False">
</HeaderStyle>
</asp:EditCommandColumn>
<asp:ButtonColumn
HeaderText="Delete item"
ButtonType="LinkButton"
Text="Delete"
CommandName="Delete"/>
<asp:BoundColumn HeaderText="Item"
ReadOnly="True"
DataField="Item"/>
<asp:BoundColumn HeaderText="Quantity"
DataField="Qty"/>
<asp:BoundColumn HeaderText="Price"
DataField="Price"
DataFormatString="{0:c}"/>
</Columns>
</asp:DataGrid>
</form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<script runat="server">
' The Cart and CartView objects temporarily store the data source
' for the DataGrid control while the page is being processed.
Dim Cart As DataTable = New DataTable()
Dim CartView As DataView
Sub Page_Load(sender As Object, e As EventArgs)
' With a database, use an select query to retrieve the data. Because
' the data source in this example is an in-memory DataTable, retrieve
' the data from session state if it exists; otherwise create the data
' source.
GetSource()
' The DataGrid control maintains state between posts to the server;
' it only needs to be bound to a data source the first time the page
' is loaded or when the data source is updated.
If Not IsPostBack Then
BindGrid()
End If
End Sub
Sub ItemsGrid_Edit(sender As Object, e As DataGridCommandEventArgs)
' Set the EditItemIndex property to the index of the item clicked
' in the DataGrid control to enable editing for that item. Be sure
' to rebind the DateGrid to the data source to refresh the control.
ItemsGrid.EditItemIndex = e.Item.ItemIndex
BindGrid()
End Sub
Sub ItemsGrid_Cancel(sender As Object, e As DataGridCommandEventArgs)
' Set the EditItemIndex property to -1 to exit editing mode.
' Be sure to rebind the DateGrid to the data source to refresh
' the control.
ItemsGrid.EditItemIndex = -1
BindGrid()
End Sub
Sub ItemsGrid_Update(sender As Object, e As DataGridCommandEventArgs)
' Retrieve the text boxes that contain the values to update.
' For bound columns, the edited value is stored in a TextBox.
' The TextBox is the 0th control in a cell's Controls collection.
' Each cell in the Cells collection of a DataGrid item represents
' a column in the DataGrid control.
Dim qtyText As TextBox = CType(e.Item.Cells(3).Controls(0), TextBox)
Dim priceText As TextBox = CType(e.Item.Cells(4).Controls(0), TextBox)
' Retrieve the updated values.
Dim item As String = e.Item.Cells(2).Text
Dim qty As String = qtyText.Text
Dim price As String = priceText.Text
Dim dr As DataRow
' With a database, use an update command to update the data.
' Because the data source in this example is an in-memory
' DataTable, delete the old row and replace it with a new one.
' Remove the old entry and clear the row filter.
CartView.RowFilter = "Item='" & item & "'"
If CartView.Count > 0 Then
CartView.Delete(0)
End If
CartView.RowFilter = ""
' ***************************************************************
' Insert data validation code here. Be sure to validate the
' values entered by the user before converting to the appropriate
' data types and updating the data source.
' ***************************************************************
' Add the new entry.
dr = Cart.NewRow()
dr(0) = Convert.ToInt32(qty)
dr(1) = item
' If necessary, remove the '$' character from the price before
' converting it to a Double.
If price.Chars(0) = "$" Then
dr(2) = Convert.ToDouble(price.Substring(1))
Else
dr(2) = Convert.ToDouble(price)
End If
Cart.Rows.Add(dr)
' Set the EditItemIndex property to -1 to exit editing mode.
' Be sure to rebind the DateGrid to the data source to refresh
' the control.
ItemsGrid.EditItemIndex = -1
BindGrid()
End Sub
Sub BindGrid()
' Set the data source and bind to the Data Grid control.
ItemsGrid.DataSource = CartView
ItemsGrid.DataBind()
End Sub
Sub GetSource()
' For this example, the data source is a DataTable that is stored
' in session state. If the data source does not exist, create it;
' otherwise, load the data.
If Session("ShoppingCart") Is Nothing Then
' Create the sample data.
Dim dr As DataRow
' Define the columns of the table.
Cart.Columns.Add(new DataColumn("Qty", GetType(Int32)))
Cart.Columns.Add(new DataColumn("Item", GetType(String)))
Cart.Columns.Add(new DataColumn("Price", GetType(Double)))
' Store the table in session state to persist its values
' between posts to the server.
Session("ShoppingCart") = Cart
' Populate the DataTable with sample data.
Dim i As Integer
For i = 1 To 9
dr = Cart.NewRow()
If (i Mod 2) <> 0 Then
dr(0) = 2
Else
dr(0) = 1
End If
dr(1) = "Item " & i.ToString()
dr(2) = (1.23 * (i + 1))
Cart.Rows.Add(dr)
Next i
Else
' Retrieve the sample data from session state.
Cart = CType(Session("ShoppingCart"), DataTable)
End If
' Create a DataView and specify the field to sort by.
CartView = New DataView(Cart)
CartView.Sort="Item"
Return
End Sub
Sub ItemsGrid_Command(sender As Object, e As DataGridCommandEventArgs)
Select (CType(e.CommandSource, LinkButton)).CommandName
Case "Delete"
DeleteItem(e)
' Add other cases here, if there are multiple ButtonColumns in
' the DataGrid control.
Case Else
' Do nothing.
End Select
End Sub
Sub DeleteItem(e As DataGridCommandEventArgs)
' e.Item is the table row where the command is raised. For bound
' columns, the value is stored in the Text property of a TableCell.
Dim itemCell As TableCell = e.Item.Cells(2)
Dim item As String = itemCell.Text
' Remove the selected item from the data source.
CartView.RowFilter = "Item='" & item + "'"
If CartView.Count > 0 Then
CartView.Delete(0)
End If
CartView.RowFilter = ""
' Rebind the data source to refresh the DataGrid control.
BindGrid()
End Sub
</script>
<head runat="server">
<title>DataGrid Editing Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DataGrid Editing Example</h3>
<asp:DataGrid id="ItemsGrid"
BorderColor="black"
BorderWidth="1"
CellPadding="3"
OnEditCommand="ItemsGrid_Edit"
OnCancelCommand="ItemsGrid_Cancel"
OnUpdateCommand="ItemsGrid_Update"
OnItemCommand="ItemsGrid_Command"
AutoGenerateColumns="false"
runat="server">
<HeaderStyle BackColor="#aaaadd">
</HeaderStyle>
<Columns>
<asp:EditCommandColumn
EditText="Edit"
CancelText="Cancel"
UpdateText="Update"
HeaderText="Edit item">
<ItemStyle Wrap="False">
</ItemStyle>
<HeaderStyle Wrap="False">
</HeaderStyle>
</asp:EditCommandColumn>
<asp:ButtonColumn
HeaderText="Delete item"
ButtonType="LinkButton"
Text="Delete"
CommandName="Delete"/>
<asp:BoundColumn HeaderText="Item"
ReadOnly="True"
DataField="Item"/>
<asp:BoundColumn HeaderText="Quantity"
DataField="Qty"/>
<asp:BoundColumn HeaderText="Price"
DataField="Price"
DataFormatString="{0:c}"/>
</Columns>
</asp:DataGrid>
</form>
</body>
</html>
Remarques
Utilisez la EditCommandColumn classe pour créer une colonne spéciale pour le DataGrid contrôle qui contient les Editboutons , Updateet Cancel pour chaque ligne de données de la grille. Ces boutons vous permettent de modifier les valeurs d’une ligne dans le DataGrid contrôle.
Si aucune ligne n’est sélectionnée, un Edit bouton s’affiche dans l’objet EditCommandColumn pour chaque ligne de données du DataGrid contrôle. Lorsque vous cliquez sur le Edit bouton d’un élément, l’événement EditCommand est déclenché et le Edit bouton est remplacé par les Update boutons et Cancel . Vous devez fournir du code pour gérer l’événement EditCommand . Un gestionnaire d’événements classique définit la EditItemIndex propriété sur la ligne sélectionnée, puis relie les données au DataGrid contrôle.
Notes
Vous devez fournir des valeurs pour les CancelTextpropriétés , EditTextet UpdateText . Sinon, les boutons associés n’apparaîtront pas dans .EditCommandColumn
Les boutons dans le EditCommandColumn peuvent être définis pour s’afficher sous forme de liens hypertexte ou de boutons push en définissant la ButtonType propriété .
Cliquer sur le Update bouton ou Cancel déclenche l’événement UpdateCommand ou CancelCommand , respectivement. Vous devez fournir du code pour gérer ces événements.
Un gestionnaire classique pour l’événement UpdateCommand met à jour les données, définit la EditItemIndex propriété sur -1 (pour désélectionner l’élément), puis relie les données au DataGrid contrôle.
Un gestionnaire classique de l’événement CancelCommand définit la EditItemIndex propriété sur -1 (pour désélectionner l’élément), puis relie les données au DataGrid contrôle.
Attention
L’objet EditCommandColumn peut être utilisé pour afficher l’entrée utilisateur, qui peut inclure un script client malveillant. Vérifiez les informations envoyées à partir d’un client pour le script exécutable, les instructions SQL ou tout autre code avant de les afficher dans votre application. Vous pouvez utiliser des contrôles de validation pour vérifier l’entrée utilisateur avant d’afficher le texte d’entrée dans un DataGrid contrôle. ASP.NET fournit une fonctionnalité de validation de demande d’entrée pour bloquer le script et le code HTML dans l’entrée utilisateur. Pour plus d’informations, consultez Sécurisation des contrôles standard, Procédure : protéger contre les attaques de script dans une application web en appliquant un encodage HTML à des chaînes et Validation des entrées utilisateur dans ASP.NET pages web.
Par défaut, la validation de page est effectuée lorsqu’un Update bouton du EditCommandColumn contrôle est cliqué. La validation de page détermine si les contrôles d’entrée associés à un contrôle de validation sur la page réussissent tous les règles de validation spécifiées par le contrôle de validation. Pour empêcher la validation de page, définissez la propriété sur CausesValidationfalse.
Constructeurs
| EditCommandColumn() |
Initialise une nouvelle instance de la classe EditCommandColumn. |
Propriétés
| ButtonType |
Obtient ou définit le type de bouton pour la colonne. |
| CancelText |
Obtient ou définit le texte à afficher pour le bouton de commande |
| CausesValidation |
Obtient ou définit une valeur indiquant si une validation est effectuée suite à un clic sur un bouton |
| DesignMode |
Obtient une valeur indiquant si la colonne est en mode design. (Hérité de DataGridColumn) |
| EditText |
Obtient ou définit le texte à afficher pour le bouton |
| FooterStyle |
Obtient les propriétés de style pour la section de pied de page de la colonne. (Hérité de DataGridColumn) |
| FooterText |
Obtient ou définit le texte affiché dans la section de pied de page de la colonne. (Hérité de DataGridColumn) |
| HeaderImageUrl |
Obtient ou définit l'emplacement d'une image à afficher dans la section d'en-tête de la colonne. (Hérité de DataGridColumn) |
| HeaderStyle |
Obtient les propriétés de style pour la section d'en-tête de la colonne. (Hérité de DataGridColumn) |
| HeaderText |
Obtient ou définit le texte affiché dans la section d'en-tête de la colonne. (Hérité de DataGridColumn) |
| IsTrackingViewState |
Obtient une valeur qui détermine si l'objet DataGridColumn est marqué pour enregistrer son état. (Hérité de DataGridColumn) |
| ItemStyle |
Obtient les propriétés de style pour les cellules d'éléments de la colonne. (Hérité de DataGridColumn) |
| Owner |
Obtient le contrôle DataGrid dont la colonne est membre. (Hérité de DataGridColumn) |
| SortExpression |
Obtient ou définit le nom du champ ou de l'expression à passer à la méthode OnSortCommand(DataGridSortCommandEventArgs) lorsqu'une colonne est sélectionnée pour être triée. (Hérité de DataGridColumn) |
| UpdateText |
Obtient ou définit le texte à afficher pour le bouton de commande |
| ValidationGroup |
Obtient ou définit le groupe de contrôles de validation pour lequel l'objet EditCommandColumn provoque la validation lors de la publication sur le serveur. |
| ViewState |
Obtient l'objet StateBag qui permet à une colonne dérivée de la classe DataGridColumn de stocker ses propriétés. (Hérité de DataGridColumn) |
| Visible |
Obtient ou définit une valeur qui indique si la colonne est visible dans le contrôle DataGrid. (Hérité de DataGridColumn) |
Méthodes
| Equals(Object) |
Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object) |
| GetHashCode() |
Fait office de fonction de hachage par défaut. (Hérité de Object) |
| GetType() |
Obtient le Type de l'instance actuelle. (Hérité de Object) |
| Initialize() |
Fournit l’implémentation de base pour réinitialiser à son état initial une colonne dérivée de la classe DataGridColumn. (Hérité de DataGridColumn) |
| InitializeCell(TableCell, Int32, ListItemType) |
Initialise une cellule dans la colonne. |
| LoadViewState(Object) |
Charge l'état de l'objet DataGridColumn. (Hérité de DataGridColumn) |
| MemberwiseClone() |
Crée une copie superficielle du Object actuel. (Hérité de Object) |
| OnColumnChanged() |
Appelle la méthode OnColumnsChanged(). (Hérité de DataGridColumn) |
| SaveViewState() |
Enregistre l'état actuel de l'objet DataGridColumn. (Hérité de DataGridColumn) |
| ToString() |
Retourne la représentation sous forme de chaîne de la colonne. (Hérité de DataGridColumn) |
| TrackViewState() |
Provoque le suivi des modifications de l'état d'affichage pour le contrôle serveur afin qu'elles puissent être stockées dans l'objet StateBag du contrôle serveur. (Hérité de DataGridColumn) |
Implémentations d’interfaces explicites
| IStateManager.IsTrackingViewState |
Obtient une valeur qui indique si la colonne suit les changements de l'état d'affichage. (Hérité de DataGridColumn) |
| IStateManager.LoadViewState(Object) |
Charge l'état enregistré précédemment. (Hérité de DataGridColumn) |
| IStateManager.SaveViewState() |
Retourne un objet contenant les modifications de l'état. (Hérité de DataGridColumn) |
| IStateManager.TrackViewState() |
Commence à suivre les modifications d'état. (Hérité de DataGridColumn) |
