This documentation is archived and is not being maintained.

ListViewUpdateEventArgs Class

Provides data for the ItemUpdating event.

System::Object
  System::EventArgs
    System.ComponentModel::CancelEventArgs
      System.Web.UI.WebControls::ListViewUpdateEventArgs

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

public ref class ListViewUpdateEventArgs : public CancelEventArgs

The ListViewUpdateEventArgs type exposes the following members.

  NameDescription
Public methodListViewUpdateEventArgsInitializes a new instance of the ListViewUpdateEventArgs class.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyItemIndexGets the index of the data item that is being updated.
Public propertyKeysGets a dictionary of field name/value pairs that represent the key or keys of the item to update.
Public propertyNewValuesGets a dictionary that contains the revised values of the item to update.
Public propertyOldValuesGets a dictionary that contains the original values of the item to update.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The ListView control raises the ItemUpdating event when the UpdateItem method is called or when an item's Update button is clicked, but before the ListView control updates the item. (An Update button is a button whose CommandName property set to "Update".) This enables you to provide an event-handling method that performs a custom routine whenever this event occurs, such as canceling the update operation.

A ListViewUpdateEventArgs object is passed to the event-handling method. This object enables you to determine the index of the current item, and to specify that the update operation should be canceled. To cancel the update operation, set the Cancel property of the ListViewUpdateEventArgs object to true. You can also work with the Keys, OldValues, and NewValues collections before the values are passed to the data source. A typical way to use these collections is to validate or to HTML-encode the values that are supplied by the user before these values are stored in the data source. This can help prevent script-injection attacks.

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

The following example shows how to use the NewValues property to make sure that the user has supplied all values before the data source is updated.

Security noteSecurity Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

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

.NET Framework

Supported in: 4, 3.5

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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