UserScopedSettingAttribute Klas

Definitie

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

Overname

Object

Attribute

SettingAttribute

UserScopedSettingAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende codevoorbeeld ziet u het gebruik van de UserScopedSettingAttribute toegepaste op alle vier de eigenschappen van de FormSettings wrapper-klasse, die is afgeleid van de ApplicationSettingsBase klasse. Deze klasse wordt gebruikt om de locatie, grootte, achtergrondkleur en tekst van het formulier te behouden. Het volledige codevoorbeeld wordt weergegeven in het ApplicationSettingsBase klassenoverzicht.

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

Opmerkingen

Eigenschappen van toepassingsinstellingen hebben een bereik dat is gebaseerd op de toepassing of op gebruikersniveau. Zoals de categorieën impliceren, bevatten eigenschappen binnen toepassingsbereik uniforme waarden voor alle gebruikers van de toepassing, terwijl eigenschappen met gebruikersbereik toegewezen waarden hebben voor elke gebruiker van de toepassing.

Hiermee UserScopedSettingAttribute wordt aangegeven dat een eigenschap moet worden beschouwd als een instelling op gebruikersniveau en dat de juiste opslagbeslissingen dienovereenkomstig moeten worden genomen door de instellingenprovider.

Er is een bereikkenmerk vereist voor elke eigenschap van de toepassingsinstellingen. Als een eigenschap niet wordt toegepast met een ApplicationScopedSettingAttribute of UserScopedSettingAttribute, wordt de eigenschap genegeerd door de provider van de instellingen. De eigenschap wordt niet geserialiseerd. Het is echter ongeldig om beide kenmerken toe te passen op dezelfde instellingeneigenschap. Een dergelijke poging zal ertoe leiden dat er een ConfigurationErrorsException wordt gegooid.

Zie ook

• ApplicationScopedSettingAttribute
• ApplicationSettingsBase
• SettingsProvider
• ConfigurationErrorsException
• Architectuur van toepassingsinstellingen