System.Web 2.0.0.0 System.ComponentModel.CancelEventArgs

The control raises the event when a row's Update button is clicked, but before the control updates the row. This allows you to provide an event-handling method that performs a custom routine, such as canceling the update operation, whenever this event occurs.

A object is passed to the event-handling method, which allows you to determine the index of the current row and to indicate that the update operation should be canceled. To cancel the update operation, set the property of the object to true. You can also manipulate the , , and collections, if necessary, before the values are passed to the data source. A common way to use these collections is to HTML-encode the values supplied by the user before they are stored in the data source. This helps to prevent script injection attacks.

For more information about handling events, see Consuming Events.

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

Provides data for the event.

- Constructor

  Use this constructor to initialize a new instance of the class using the specified row index.

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

  Property

  Initial value

  The value contained in the parameter.

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

  Initializes a new instance of the class.

  The index of the row being updated.
  2.0.0.0
- Property
  System.Collections.Specialized.IOrderedDictionary To be added.

  When the property of a control is set, use the property (dictionary) to access the value of the primary key in the row to update.

  To access the values of the non-key fields, use the or properties. The property contains the updated values, while the property contains the original values.

  The dictionary is automatically populated with the name/value pairs of the field or fields specified in the property. If multiple fields form the primary key, a separate entry is added to the dictionary for each key field.

  To determine the name of a key field, use the property of a object contained in the dictionary. To determine the value of a key field, use the property.

  Gets a dictionary of field name/value pairs that represent the primary key of the row to update.

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

  Use the property (dictionary) to access the values of the revised non-key fields in the row to update.

  The primary key field or fields are not included in this dictionary. To access the values of the primary key field or fields, use the property. To access the original values of the non-key fields in the row, use the property.

  The property is automatically populated with the name/value pairs of the revised non-key fields in the row. A separate entry is added to the property for each non-key field in the row.

  To determine the field name of an entry, use the property of a object contained in the dictionary. To determine the value of an entry, use the property.

  Gets a dictionary containing the revised values of the non-key field name/value pairs in the row to update.

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

  Use the property (dictionary) to access the original values of the fields in the row to update. This dictionary contains all fields in the row except the key fields. The key fields are defined in the property of a control.

  You can access the key fields of the row by using the property. To access the revised values of the non-key fields in the row, use the property.

  The property is automatically populated with the original values of all the field name/value pairs in the row. A separate entry is added to the property for each field in the row.

  To determine the field name of an entry, use the property of a object contained in the dictionary. To determine the value of an entry, use the property.

  Gets a dictionary containing the original field name/value pairs in the row to update.

  2.0.0.0
- Property
  System.Int32 To be added.

  Use the property to determine the index of the row being updated. The row index is often used to retrieve the corresponding row from the collection of the control, which allows you to access the row's properties.

  Gets the index of the row being updated.

  2.0.0.0