DefaultSettingValueAttribute Classe

Définition

Espace de noms:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paquet:

System.Configuration.ConfigurationManager v8.0.0

Source:

DefaultSettingValueAttribute.cs

Spécifie la valeur par défaut d’une propriété de paramètre d’application.

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

Héritage

Object

Attribute

DefaultSettingValueAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant illustre l’utilisation du DefaultSettingValueAttribute appliqué à trois des quatre propriétés de la FormSettings classe wrapper, qui est dérivée de la ApplicationSettingsBase classe . Cette classe est utilisée pour conserver l’emplacement, la taille, la couleur d’arrière-plan et le texte de la forme. Les trois premières de ces propriétés de formulaire ont des valeurs par défaut associées.

L’exemple de code complet est répertorié dans la vue d’ensemble de la 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

Remarques

Important

DefaultSettingValueAttribute ne peut être appliqué qu’aux propriétés de paramètres individuelles ; l’application de cet attribut à l’ensemble d’une classe de paramètres d’application n’est pas valide.

Différents fournisseurs de paramètres peuvent avoir des exigences ou des limitations différentes sur l’utilisation de .DefaultSettingValueAttribute Par exemple, le LocalFileSettingsProvider ne nécessite pas cet attribut et remplace toute valeur fournie par cet attribut s’il existe des valeurs (par défaut ou modifiées par l’utilisateur) déjà présentes dans le magasin de données.

DefaultSettingValueAttribute nécessite que la valeur par défaut puisse être représentée sous la forme d’une chaîne. Par conséquent, les paramètres utilisant la sérialisation XML ne peuvent pas avoir une valeur par défaut spécifiée au moyen de cet attribut. Certains fournisseurs peuvent choisir de prendre en charge plusieurs schémas de sérialisation qui peuvent être spécifiés au moment de la compilation à l’aide de SettingsSerializeAsAttribute.

Attention

Les valeurs par défaut spécifiées par cet attribut sont stockées sous forme de texte brut dans le fichier .exe ou .dll compilé résultant. Par conséquent, ces valeurs par défaut sont intrinsèquement non sécurisées.

Constructeurs

DefaultSettingValueAttribute(String)

Initialise une instance de la classe DefaultSettingValueAttribute.

Propriétés

TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)
Value	Obtient la valeur par défaut pour la propriété de paramètres d’application.

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Paramètres d’application pour Windows Forms