This documentation is archived and is not being maintained.

ObjectDataSource.OldValuesParameterFormatString Property

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 string OldValuesParameterFormatString { get; set; }
<asp:ObjectDataSource OldValuesParameterFormatString="String" />

Property Value

Type: System.String
A string that represents a format string applied to the names of any oldValues or key parameters passed to the Delete or Update methods. The default is "{0}", which means the parameter name is the field name.

The value of the OldValuesParameterFormatString property 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 are passed to the corresponding data method.

The following are two common scenarios where you might change the OldValuesParameterFormatString property:

  • You might want to change the property 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 OldValuesParameterFormatString property delegates to the OldValuesParameterFormatString property of the ObjectDataSourceView object that is associated with the ObjectDataSource control.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.