SqlDataSource.OldValuesParameterFormatString Property

Note: This property is new in the .NET Framework version 2.0.

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 */
public String get_OldValuesParameterFormatString ()

/** @property */
public void set_OldValuesParameterFormatString (String value)

public function get OldValuesParameterFormatString () : String

public function set OldValuesParameterFormatString (value : String)

Property Value

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.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0