DefaultSettingValueAttribute Klasse

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paket:

System.Configuration.ConfigurationManager v8.0.0

Quelle:

DefaultSettingValueAttribute.cs

Gibt den Standardwert für eine Anwendungseinstellungseigenschaft an.

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

Vererbung

Object

Attribute

DefaultSettingValueAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung der DefaultSettingValueAttribute auf drei der vier Eigenschaften der FormSettings Wrapperklasse angewendet, 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. Den ersten drei dieser Formulareigenschaften sind Standardwerte zugeordnet.

Das vollständige Codebeispiel ist 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

Wichtig

DefaultSettingValueAttribute kann nur auf einzelne Einstellungseigenschaften angewendet werden; Es ist ungültig, dieses Attribut auf eine gesamte Anwendungseinstellungsklasse anzuwenden.

Verschiedene Einstellungsanbieter haben möglicherweise unterschiedliche Anforderungen oder Einschränkungen für die Verwendung von DefaultSettingValueAttribute. Beispielsweise ist dieses LocalFileSettingsProvider Attribut nicht erforderlich und überschreibt alle von diesem Attribut bereitgestellten Werte, wenn bereits Werte im Datenspeicher vorhanden sind – Standard- oder benutzerseitig geänderte Werte.

DefaultSettingValueAttribute erfordert, dass der Standardwert als Zeichenfolge dargestellt werden kann. Daher kann für Einstellungen, die die XML-Serialisierung verwenden, kein Standardwert angegeben werden, der mithilfe dieses Attributs angegeben wird. Einige Anbieter unterstützen möglicherweise mehrere Serialisierungsschemas, die zur Kompilierzeit mithilfe von SettingsSerializeAsAttributeangegeben werden können.

Achtung

Die von diesem Attribut angegebenen Standardwerte werden als Nur-Text in der resultierenden kompilierten .exe- oder .dll-Datei gespeichert. Daher sind diese Standardwerte von Natur aus unsicher.

Konstruktoren

DefaultSettingValueAttribute(String)

Initialisiert eine Instanz der DefaultSettingValueAttribute-Klasse.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Value	Ruft den Standardwert für die Anwendungseinstellungseigenschaft ab.

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Anwendungseinstellungen für Windows Forms