This documentation is archived and is not being maintained.

SettingsPropertyValue.IsDirty Property

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

Gets or sets whether the value of a SettingsProperty object has changed.

Namespace: System.Configuration
Assembly: System (in system.dll)

public bool IsDirty { get; set; 
/** @property */
public boolean get_IsDirty ()

/** @property */
public void set_IsDirty (boolean value)

public function get IsDirty () : boolean

public function set IsDirty (value : boolean)

Property Value

true if the value of a SettingsProperty object has changed; otherwise, false.

The IsDirty property indicates that the value stored by this class has changed. The default is false. The IsDirty property is set to true under the following conditions:

  1. The value contained in the SettingsPropertyValue object is changed.

  2. The value contained in the SettingsPropertyValue object is accessed, and the value is not a string or a primitive type such as int, float, real, or DateTime. When the value managed by a SettingsPropertyValue object is a complex type (for example an ArrayList), there is no way for a SettingsPropertyValue object to detect when changes have been made. As a result, the SettingsPropertyValue object pessimistically assumes that a complex type is dirty once it has been accessed from the PropertyValue property.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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