UserScopedSettingAttribute Class
Assembly: System (in system.dll)
'Declaration <AttributeUsageAttribute(AttributeTargets.Property)> _ Public NotInheritable Class UserScopedSettingAttribute Inherits SettingAttribute 'Usage Dim instance As UserScopedSettingAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ public final class UserScopedSettingAttribute extends SettingAttribute
AttributeUsageAttribute(AttributeTargets.Property) public final class UserScopedSettingAttribute extends SettingAttribute
Not applicable.
Application settings properties have a scope that is based either at the application or the user level. As the categories imply, application-scoped properties present uniform values to all users of the application, whereas user-scoped properties have dedicated values for each user of the application.
The UserScopedSettingAttribute indicates that a property should be considered a user level setting, and that appropriate storage decisions should be made accordingly by the settings provider.
A scope attribute is required for each application settings property. If a property is not applied with either a ApplicationScopedSettingAttribute or UserScopedSettingAttribute, the property is ignored by the settings provider—it is not serialized. It is invalid, however, to apply both attributes to the same settings property. Such an attempt will cause a ConfigurationErrorsException to be thrown.
The following code example demonstrates the use of the UserScopedSettingAttribute applied to all 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 full code example is listed in the ApplicationSettingsBase class overview.
'Application settings wrapper class. This class defines the settings we intend to use in our application. NotInheritable Class FormSettings Inherits ApplicationSettingsBase <UserScopedSettingAttribute()> _ Public Property FormText() As String Get Return CStr(Me("FormText")) End Get Set(ByVal value As String) Me("FormText") = value End Set End Property <UserScopedSetting(), DefaultSettingValueAttribute("0, 0")> _ Public Property FormLocation() As Point Get Return CType(Me("FormLocation"), Point) End Get Set(ByVal value As Point) Me("FormLocation") = value End Set End Property <UserScopedSetting(), DefaultSettingValueAttribute("225, 200")> _ Public Property FormSize() As Size Get Return CType(Me("FormSize"), Size) End Get Set(ByVal value As Size) Me("FormSize") = value End Set End Property <UserScopedSetting(), DefaultSettingValueAttribute("LightGray")> _ Public Property FormBackColor() As Color Get Return CType(Me("FormBackColor"), Color) End Get Set(ByVal value As Color) Me("FormBackColor") = value End Set End Property End Class
System.Attribute
System.Configuration.SettingAttribute
System.Configuration.UserScopedSettingAttribute
Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.