DefaultSettingValueAttribute Classe

Definição

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Pacote:

System.Configuration.ConfigurationManager v8.0.0

Origem:

DefaultSettingValueAttribute.cs

Especifica o valor padrão de uma propriedade de configurações do aplicativo.

public ref class DefaultSettingValueAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class DefaultSettingValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type DefaultSettingValueAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultSettingValueAttribute
Inherits Attribute

Herança

Object

Attribute

DefaultSettingValueAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir demonstra o uso do DefaultSettingValueAttribute aplicado a três das 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. As três primeiras dessas propriedades de formulário têm valores padrão associados a elas.

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

Importante

DefaultSettingValueAttribute só pode ser aplicado a propriedades de configurações individuais; é inválido aplicar esse atributo a uma classe de configurações de aplicativo inteira.

Provedores de configurações diferentes podem ter requisitos ou limitações diferentes no uso do DefaultSettingValueAttribute. Por exemplo, o LocalFileSettingsProvider não requer esse atributo e substituirá qualquer valor fornecido por esse atributo se houver algum valor – padrão ou modificado pelo usuário – já presente no armazenamento de dados.

DefaultSettingValueAttribute requer que o valor padrão possa ser representado como uma cadeia de caracteres. Como resultado, as configurações que usam a serialização XML não podem ter um valor padrão especificado por meio desse atributo. Alguns provedores podem optar por dar suporte a vários esquemas de serialização que podem ser especificados em tempo de compilação usando o SettingsSerializeAsAttribute.

Cuidado

Os valores padrão especificados por esse atributo são armazenados como texto sem formatação no arquivo de .exe ou .dll resultante. Portanto, esses valores padrão são inerentemente inseguros.

Construtores

DefaultSettingValueAttribute(String)

Inicializa uma instância da classe DefaultSettingValueAttribute.

Propriedades

TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
Value	Obtém o valor padrão da propriedade de configurações do aplicativo.

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Configurações do aplicativo para Windows Forms