SettingsPropertyValue.IsDirty Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-rc.2.24473.5

Source:

SettingsPropertyValue.cs

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

public:
 property bool IsDirty { bool get(); void set(bool value); };

public bool IsDirty { get; set; }

member this.IsDirty : bool with get, set

Public Property IsDirty As Boolean

Property Value

Boolean

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

Remarks

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.