FormViewDeleteEventArgs.Keys Property

 

Gets an ordered dictionary of key field name/value pairs for the record to delete.

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

member Keys : IOrderedDictionary with get

Property Value

Type: System.Collections.Specialized.IOrderedDictionary

An OrderedDictionary that contains the key field name/value pairs for the record to delete.

The Keys property contains the values of the key fields listed in the DataKeyNames property of a FormView control. Use the Keys property to access the values of the key field or fields for the record to be deleted. For example, you can use these values to verify the record before deleting it, to change the record to delete, or to keep a log of deleted records.

System_CAPS_noteNote

This property contains only the key fields. To access the name/value pair values for the non-key fields, use the Values property.

The Keys property returns an OrderedDictionary object that implements the System.Collections.Specialized.IOrderedDictionary interface. The OrderedDictionary object contains System.Collections.DictionaryEntry objects that represent the key fields. To access the key field names, use the Keys property of the OrderedDictionary object. Similarly, you can access the key field values by using the Values property.

System_CAPS_noteNote

As a shortcut, you can also use the indexer of the OrderedDictionary object to access the key field values. The advantage in using the indexer is that it returns key field values directly. Data source controls that rely on the field order (such as AccessDataSource) can access key field values only by index.

The Keys and Values properties are read-only; however, you can modify the field values of the OrderedDictionary object. If you change the key and non-key field values, the corresponding record will be deleted from the data source.

The following example demonstrates how to use the Keys property to access the value of the key field for the record being deleted.

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

.NET Framework
Available since 2.0
Return to top
Show: