DefaultSettingValueAttribute Clase

Definición

Espacio de nombres:

System.Configuration

Ensamblado:

System.Configuration.ConfigurationManager.dll

Paquete:

System.Configuration.ConfigurationManager v8.0.0

Source:

DefaultSettingValueAttribute.cs

Especifica el valor predeterminado para una propiedad de configuración de aplicación.

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

Herencia

Object

Attribute

DefaultSettingValueAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo de código siguiente se muestra el uso de aplicado DefaultSettingValueAttribute a tres de las cuatro propiedades de la FormSettings clase contenedora, que se deriva de la ApplicationSettingsBase clase . Esta clase se usa para conservar la ubicación, el tamaño, el color de fondo y el texto del formulario. Las tres primeras de estas propiedades de formulario tienen valores predeterminados asociados.

El ejemplo de código completo se muestra en la información general de la ApplicationSettingsBase clase.

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

Comentarios

Importante

DefaultSettingValueAttribute solo se puede aplicar a propiedades de configuración individuales; no es válido aplicar este atributo a toda una clase de configuración de aplicación.

Los distintos proveedores de configuración pueden tener requisitos o limitaciones diferentes en el uso de DefaultSettingValueAttribute. Por ejemplo, el LocalFileSettingsProvider no requiere este atributo y invalidará cualquier valor proporcionado por este atributo si hay valores (predeterminados o modificados por el usuario) que ya están presentes en el almacén de datos.

DefaultSettingValueAttribute requiere que el valor predeterminado se pueda representar como una cadena. Como resultado, la configuración que usa la serialización XML no puede tener un valor predeterminado especificado por medio de este atributo. Algunos proveedores pueden optar por admitir varios esquemas de serialización que se pueden especificar en tiempo de compilación mediante SettingsSerializeAsAttribute.

Precaución

Los valores predeterminados especificados por este atributo se almacenan como texto sin formato en el archivo de .exe compilado resultante o .dll. Por lo tanto, estos valores predeterminados son intrínsecamente inseguros.

Constructores

DefaultSettingValueAttribute(String)

Inicializa una instancia de la clase DefaultSettingValueAttribute.

Propiedades

TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)
Value	Obtiene el valor predeterminado para la propiedad de configuración de aplicación.

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Configuración de la aplicación en formularios Windows Forms