SettingsPropertyValue.IsDirty Property

Definition

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

C#
public bool IsDirty { get; set; }

Property Value

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.

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9