UserScopedSettingAttribute Klasse

Definition

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

Vererbung

Object

Attribute

SettingAttribute

UserScopedSettingAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung der UserScopedSettingAttribute angewendeten vier Eigenschaften der FormSettings Wrapperklasse, die von der ApplicationSettingsBase Klasse abgeleitet wird. Diese Klasse wird verwendet, um den Speicherort, die Größe, die Hintergrundfarbe und den Text des Formulars beizubehalten. Das vollständige Codebeispiel wird in der ApplicationSettingsBase Klassenübersicht aufgeführt.

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

Hinweise

Anwendungseinstellungseigenschaften weisen einen Bereich auf, der entweder auf der Anwendung oder auf Benutzerebene basiert. Da die Kategorien implizieren, stellen Anwendungsbereichseigenschaften für alle Benutzer der Anwendung einheitliche Werte dar, während benutzerbezogene Eigenschaften dedizierte Werte für jeden Benutzer der Anwendung aufweisen.

Dies UserScopedSettingAttribute gibt an, dass eine Eigenschaft als Einstellung auf Benutzerebene betrachtet werden soll und dass entsprechende Speicherentscheidungen vom Einstellungsanbieter entsprechend getroffen werden sollten.

Für jede Anwendungseinstellungseigenschaft ist ein Bereichsattribut erforderlich. Wenn eine Eigenschaft nicht mit einer oder UserScopedSettingAttributeeiner ApplicationScopedSettingAttribute Eigenschaft angewendet wird, wird die Eigenschaft vom Einstellungsanbieter ignoriert – sie wird nicht serialisiert. Es ist jedoch ungültig, beide Attribute auf dieselbe Einstellungseigenschaft anzuwenden. Ein solcher Versuch führt dazu, dass ein ConfigurationErrorsException Solcher Versuch ausgelöst wird.

Weitere Informationen

• ApplicationScopedSettingAttribute
• ApplicationSettingsBase
• SettingsProvider
• ConfigurationErrorsException
• Architektur der Anwendungseinstellungen