UserScopedSettingAttribute Classe

Definição

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

Herança

Object

Attribute

SettingAttribute

UserScopedSettingAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir demonstra o uso do UserScopedSettingAttribute aplicado a todas as quatro propriedades da FormSettings classe wrapper, que é derivada da ApplicationSettingsBase classe . Essa classe é usada para persistir o local, o tamanho, a cor da tela de fundo e o texto do formulário. O exemplo de código completo está listado na visão geral da ApplicationSettingsBase classe.

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

Comentários

As propriedades de configurações do aplicativo têm um escopo baseado no aplicativo ou no nível do usuário. Como as categorias implicam, as propriedades no escopo do aplicativo apresentam valores uniformes para todos os usuários do aplicativo, enquanto as propriedades no escopo do usuário têm valores dedicados para cada usuário do aplicativo.

O UserScopedSettingAttribute indica que uma propriedade deve ser considerada uma configuração de nível de usuário e que as decisões de armazenamento apropriadas devem ser tomadas de acordo com o provedor de configurações.

Um atributo de escopo é necessário para cada propriedade de configurações do aplicativo. Se uma propriedade não for aplicada com um ApplicationScopedSettingAttribute ou UserScopedSettingAttribute, a propriedade será ignorada pelo provedor de configurações – ela não será serializada. No entanto, é inválido aplicar ambos os atributos à mesma propriedade de configurações. Tal tentativa fará com que um ConfigurationErrorsException seja lançado.

Construtores

Propriedades

Métodos

Implantações explícitas de interface

Aplica-se a

Confira também

• ApplicationScopedSettingAttribute
• ApplicationSettingsBase
• SettingsProvider
• ConfigurationErrorsException
• Arquitetura das configurações do aplicativo