DefaultSettingValueAttribute Class
Specifies the default value for an application settings property.
Assembly: System (in System.dll)
The DefaultSettingValueAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | DefaultSettingValueAttribute | Initializes an instance of the DefaultSettingValueAttribute class. |
| Name | Description | |
|---|---|---|
![]() | Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Important |
|---|
DefaultSettingValueAttribute can only be applied to individual settings properties; it is invalid to apply this attribute to an entire application settings class. |
Different settings providers may have different requirements or limitations on the use of the DefaultSettingValueAttribute. For example, the LocalFileSettingsProvider does not require this attribute, and will override any value provided by this attribute if there are any values—default or user-modified— already present in the data store.
DefaultSettingValueAttribute requires that the default value can be represented as a string. As a result, settings using XML serialization cannot have a default value specified by means of this attribute. Some providers may choose to support multiple serialization schemes which can be specified at compile time using the SettingsSerializeAsAttribute.
Caution |
|---|
The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Therefore these default values are inherently insecure. |
The following code example demonstrates the use of the DefaultSettingValueAttribute applied to three of the four properties of the FormSettings wrapper class, which is derived from the ApplicationSettingsBase class. This class is used to persist the location, size, background color, and text of form. The first three of these form properties have default values associated with them.
The full code example is listed in the ApplicationSettingsBase class overview.
//Application settings wrapper class ref class FormSettings sealed: public ApplicationSettingsBase { public: [UserScopedSettingAttribute()] property String^ FormText { String^ get() { return (String^)this["FormText"]; } void set( String^ value ) { this["FormText"] = value; } } public: [UserScopedSettingAttribute()] [DefaultSettingValueAttribute("0, 0")] property Point FormLocation { Point get() { return (Point)(this["FormLocation"]); } void set( Point value ) { this["FormLocation"] = value; } } public: [UserScopedSettingAttribute()] [DefaultSettingValueAttribute("225, 200")] property Size FormSize { Size get() { return (Size)this["FormSize"]; } void set( Size value ) { this["FormSize"] = value; } } public: [UserScopedSettingAttribute()] [DefaultSettingValueAttribute("LightGray")] property Color FormBackColor { Color get() { return (Color)this["FormBackColor"]; } void set(Color value) { this["FormBackColor"] = value; } } };
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
