UserScopedSettingAttribute 类

定义

命名空间:

System.Configuration

程序集:

System.Configuration.ConfigurationManager.dll

包:

System.Configuration.ConfigurationManager v8.0.0

Source:

UserScopedSettingAttribute.cs

指定应用程序设置组或属性对于应用程序的每个用户包含不同的值。 此类不能被继承。

public ref class UserScopedSettingAttribute sealed : System::Configuration::SettingAttribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class UserScopedSettingAttribute : System.Configuration.SettingAttribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type UserScopedSettingAttribute = class
    inherit SettingAttribute

Public NotInheritable Class UserScopedSettingAttribute
Inherits SettingAttribute

继承

Object

Attribute

SettingAttribute

UserScopedSettingAttribute

属性

AttributeUsageAttribute

示例

下面的代码示例演示如何使用 UserScopedSettingAttribute 应用于包装类的所有四个属性，该属性 FormSettings 派生自 ApplicationSettingsBase 类。 此类用于保留窗体的位置、大小、背景色和文本。 类概述中 ApplicationSettingsBase 列出了完整的代码示例。

//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;
        }
    }

};

//Application settings wrapper class
sealed class FormSettings : ApplicationSettingsBase
{
    [UserScopedSettingAttribute()]
    public String FormText
    {
        get { return (String)this["FormText"]; }
        set { this["FormText"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("0, 0")]
    public Point FormLocation
    {
        get { return (Point)(this["FormLocation"]); }
        set { this["FormLocation"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("225, 200")]
    public Size FormSize
    {
        get { return (Size)this["FormSize"]; }
        set { this["FormSize"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("LightGray")]
    public Color FormBackColor
    {
        get { return (Color)this["FormBackColor"]; }
        set { this["FormBackColor"] = value; }
    }
}

'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

    <UserScopedSettingAttribute(), 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

    <UserScopedSettingAttribute(), 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

    <UserScopedSettingAttribute(), 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

注解

应用程序设置属性的范围基于应用程序或用户级别。 正如类别所暗示的那样，应用程序范围的属性向应用程序的所有用户提供统一值，而用户范围的属性为应用程序的每个用户提供专用值。

UserScopedSettingAttribute指示属性应被视为用户级别设置，并且设置提供程序应相应地做出适当的存储决策。

每个应用程序设置属性都需要一个范围属性。 如果属性未与 或 UserScopedSettingAttribute一起ApplicationScopedSettingAttribute应用，则设置提供程序会忽略该属性 - 它不会被序列化。 但是，将这两个属性应用于同一设置属性是无效的。 这种尝试将导致 ConfigurationErrorsException 引发 。

构造函数

UserScopedSettingAttribute()

初始化 UserScopedSettingAttribute 类的新实例。

属性

TypeId

在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

另请参阅

• ApplicationScopedSettingAttribute
• ApplicationSettingsBase
• SettingsProvider
• ConfigurationErrorsException
• 应用程序设置体系结构