UserScopedSettingAttribute Classe

Définition

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

Héritage

Object

Attribute

SettingAttribute

UserScopedSettingAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant illustre l’utilisation du UserScopedSettingAttribute appliqué aux 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. 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

Les propriétés des paramètres d’application ont une étendue qui est basée au niveau de l’application ou de l’utilisateur. Comme l’impliquent les catégories, les propriétés étendues à l’application présentent des valeurs uniformes à tous les utilisateurs de l’application, tandis que les propriétés étendues à l’utilisateur ont des valeurs dédiées pour chaque utilisateur de l’application.

indique UserScopedSettingAttribute qu’une propriété doit être considérée comme un paramètre de niveau utilisateur et que les décisions de stockage appropriées doivent être prises en conséquence par le fournisseur de paramètres.

Un attribut d’étendue est requis pour chaque propriété de paramètres d’application. Si une propriété n’est pas appliquée avec un ApplicationScopedSettingAttribute ou UserScopedSettingAttribute, la propriété est ignorée par le fournisseur de paramètres . Elle n’est pas sérialisée. Toutefois, il n’est pas valide d’appliquer les deux attributs à la même propriété de paramètres. Une telle tentative entraîne la levée d’un ConfigurationErrorsException .

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à

Voir aussi

• ApplicationScopedSettingAttribute
• ApplicationSettingsBase
• SettingsProvider
• ConfigurationErrorsException
• Architecture des paramètres d'application