SqlDataSource.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 any parameters that are passed to the Delete or Update method.

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

public string OldValuesParameterFormatString { get; set; }

Property Value

Type: System.String

A string that represents a format string applied to the names of any oldValues parameters passed to the Delete or Update methods. The default is "{0}".

The OldValuesParameterFormatString format string is applied only to primary keys, such as those that are identified by the DataKeyNames property of the associated data-bound control, or in delete and update scenarios where the ConflictDetection property is set to the CompareAllValues value and a set of oldValues are passed to the corresponding data method. In this case, the format string is applied to each parameter name in the oldValues collection.

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.

.NET Framework
Available since 2.0
Return to top