DetailsViewInsertEventArgs Class
Provides data for the ItemInserting event.
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.DetailsViewInsertEventArgs
Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
The DetailsViewInsertEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | DetailsViewInsertEventArgs | Initializes a new instance of the DetailsViewInsertEventArgs class. |
| Name | Description | |
|---|---|---|
| Cancel | Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.) |
| CommandArgument | Gets the command argument for the insert operation passed to the DetailsView control. |
| Values | Gets a dictionary that contains the field name/value pairs for the record to insert. |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
The DetailsView control raises the ItemInserting event when an Insert button (a button with its CommandName property set to "Insert") within the control is clicked, but before the DetailsView control inserts the record. This allows you to provide an event handler that performs a custom routine, such as HTML-encoding the values of a record before inserting it in the data source, whenever this event occurs.
A DetailsViewInsertEventArgs object is passed to the event handler, which allows you to determine the value of an optional command argument sent to the DetailsView control and to indicate that the insert operation should be canceled. To determine the value of the command argument, use the CommandArgument property. To cancel the insert operation, set the Cancel property to true. You can also read or modify the field values for the new record by using the Values property.
For more information about handling events, see Consuming Events.
For a list of initial property values for an instance of the DetailsViewInsertEventArgs class, see the DetailsViewInsertEventArgs constructor.
The following code example demonstrates how to use the DetailsViewInsertEventArgs object passed to the event handler for the ItemInserting event to cancel an insert operation.
<%@ 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 CustomerDetailsView_ItemInserting(Object sender, DetailsViewInsertEventArgs e) { // Use the Values property to retrieve the key field value. String keyValue = e.Values["CustomerID"].ToString(); // Insert the record only if the key field is four characters // long; otherwise, cancel the insert operation. if (keyValue.Length == 4) { // Change the key field value to upper case before inserting // the record in the data source. e.Values["CustomerID"] = keyValue.ToUpper(); MessageLabel.Text = ""; } else { MessageLabel.Text = "The key field must have four digits."; e.Cancel = true; } } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>DetailsViewInsertEventArgs Example</title> </head> <body> <form id="form1" runat="server"> <h3>DetailsViewInsertEventArgs Example</h3> <asp:detailsview id="CustomerDetailsView" datasourceid="DetailsViewSource" datakeynames="CustomerID" autogenerateinsertbutton="true" autogeneraterows="true" allowpaging="true" oniteminserting="CustomerDetailsView_ItemInserting" runat="server"> <fieldheaderstyle backcolor="Navy" forecolor="White"/> </asp:detailsview> <asp:label id="MessageLabel" forecolor="Red" runat="server"/> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the web.config file. --> <asp:sqldatasource id="DetailsViewSource" selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]" insertcommand="INSERT INTO [Customers]([CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country]) VALUES (@CustomerID, @CompanyName, @Address, @City, @PostalCode, @Country)" connectionstring= "<%$ ConnectionStrings:NorthWindConnectionString%>" runat="server"/> </form> </body> </html>
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
