System.Web 2.0.0.0 System.ComponentModel.CancelEventArgs

The control raises the event when an Update button (a button with its CommandName property set to "Update") within the control is clicked, but before the control updates the record. This allows you to provide an event-handling method that performs a custom routine, such as HTML encoding or validating the values of a record before updating it in the data source, whenever this event occurs.

A object is passed to the event-handling method, which allows you to determine the value of an optional command argument sent to the control and to indicate whether the update operation should be canceled. To determine the value of the command argument, use the property. To cancel the update operation, set the property to true. If you need to access the original key field values for the record being updated, use the property. The original non-key field values can be accessed by using the property. Updated values (which include updated key field values, if you allow the user to edit key fields) are accessed using the property.

For more information about handling events, see Consuming Events.

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

Provides data for the event.

- Constructor
  To be added.

  Use this constructor to initialize a new instance of the class.

  The following table shows the initial property value for an instance of the class.

  Property

  Initial Value

  The value of the parameter.

  This constructor is used primarily by control developers when raising events.

  Initializes a new instance of the class.

  2.0.0.0
- Property
  System.Object To be added.

  When you create an Update button for one of the templates in a control, you can optionally specify a command argument for the button by using the property. The command argument usually contains any optional information you want to accompany the update command, such as the value for the key field. The property is provided as a convenient way to determine the value of the Update button's command argument.

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

  2.0.0.0
- Property
  System.Collections.Specialized.IOrderedDictionary To be added.

  The property contains the original values of the key fields listed in the property of a control. Use the property to access the original values of the key fields for the record to update. For example, you can use these values to keep a log of updated records.

  If you allow the user to update the values of the key fields, the property contains the original key field values. The updated values are stored in the property.

  The property returns an object that implements the interface. The object contains objects that represent the fields of the updated record. To access the field names, use the property of the object. Similarly, you can access the field values by using the property.

  As a shortcut, you can also use the indexer of the object to access the field values directly. Data source controls that rely on the field order (such as ) can access field values only by index.

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

  2.0.0.0
- Property
  System.Collections.Specialized.IOrderedDictionary To be added.

  Use the property to access the new field values for the record to update. For example, you can use these values to keep a log of updated records.

  If you allow the user to update the values of the key fields, the property contains the original key field values. The updated values are stored in the property.

  The property returns an object that implements the interface. The object contains objects that represent the fields of the updated record. To access the field names, use the property of the object. Similarly, you can access the field values by using the property.

  As a shortcut, you can also use the indexer of the object to access the field values directly. Data source controls that rely on the field order (such as ) can access field values only by index.

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

  2.0.0.0
- Property
  System.Collections.Specialized.IOrderedDictionary To be added.

  Use the property to access the original non-key field values for the updated record. For example, you can use these values to keep a log of updated records. Some data source controls, such as the and controls, support conflict detection (optimistic concurrency checking). When the property of one of these controls is set to ConflictOptions.CompareAllValues, the original values of the record are compared against the values in the data source before an update operation is performed. If a record has been modified by another user concurrently, the record is not updated.

  The property does not contain key fields. If you allow the user to update the values of the key fields, the original key field values are stored in the property. The updated values are stored in the property.

  The property returns an object that implements the interface. The object contains objects that represent the fields of the updated record. To access the field names, use the property of the object. Similarly, you can access the field values by using the property.

  As a shortcut, you can also use the indexer of the object to access the field values directly. Data source controls that rely on the field order (such as ) can access field values only by index.

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

  2.0.0.0