DetailsViewUpdateEventArgs Class

 

Provides data for the ItemUpdating event.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.DetailsViewUpdateEventArgs

type DetailsViewUpdateEventArgs = 
    class
        inherit CancelEventArgs
    end

NameDescription
System_CAPS_pubmethodDetailsViewUpdateEventArgs(Object)

Initializes a new instance of the DetailsViewUpdateEventArgs class.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)

System_CAPS_pubpropertyCommandArgument

Gets the command argument for the update operation passed to the DetailsView control.

System_CAPS_pubpropertyKeys

Gets a dictionary that contains the key field name/value pairs for the record to update.

System_CAPS_pubpropertyNewValues

Gets a dictionary that contains the new field name/value pairs for the record to update.

System_CAPS_pubpropertyOldValues

Gets a dictionary that contains the original field name/value pairs for the record to update.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The DetailsView control raises the ItemUpdating event when an Update button (a button with its CommandName property set to "Update") within the control is clicked, but before the DetailsView control updates 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 updating it in the data source, whenever this event occurs.

A DetailsViewUpdateEventArgs 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 whether the update operation should be canceled. To determine the value of the command argument, use the CommandArgument property. To cancel the update operation, set the Cancel property to true. You can also read or modify the new values entered by the user by using the Keys and NewValues properties. The Keys property contains the key fields, while the NewValues property contains the non-key fields. If you need to access the original non-key field values, use the OldValues property.

For more information about handling events, see NIB: Consuming Events.

For a list of initial property values for an instance of the DetailsViewUpdateEventArgs class, see the DetailsViewUpdateEventArgs constructor.

The following code example demonstrates how to use the DetailsViewUpdateEventArgs object passed to the event handler for the ItemUpdating event to validate the values entered by the user.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: