ObjectDataSourceView.OldValuesParameterFormatString Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a format string to apply to the names of the parameters for original values that are passed to the Delete or Update methods.

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

Public Property OldValuesParameterFormatString As String

Property Value

Type: System.String

A string that represents a format string applied to the names of any oldValues passed to the Delete or Update method. The default is "{0}", which means the parameter name is simply the field name.

The OldValuesParameterFormatString format string is applied to primary keys only, such as those that are identified with the DataKeyNames property of a data-bound control or in delete and update scenarios, where the ConflictDetection property is set to the CompareAllValues value and the set of original values that are passed to the corresponding data method.

Two common scenarios where you might change the OldValuesParameterFormatString property are as follows:

  • To differentiate between old and new values in updates. When the ConflictDetection property is set to the CompareAllValues value, parameters for both the original and new values are added to the UpdateParameters collection. Without the formatting string, two parameters with the same name would be created for each data field. By changing the name of the original value parameter, you can compare the data to the original data source to detect conflicts and compare key values.

  • Some visual designers implement a particular naming scheme for original values and keys.

The value of the OldValuesParameterFormatString is stored in view state.

.NET Framework
Available since 2.0
Return to top