DefaultSettingValueAttribute Klasse

Definition

Gibt den Standardwert für eine Anwendungseinstellungseigenschaft an.Specifies the default value for an application settings property.

public ref class DefaultSettingValueAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class DefaultSettingValueAttribute : Attribute
type DefaultSettingValueAttribute = class
    inherit Attribute
Public NotInheritable Class DefaultSettingValueAttribute
Inherits Attribute
Vererbung
DefaultSettingValueAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung von DefaultSettingValueAttribute veranschaulicht, die auf drei der vier Eigenschaften FormSettings der Wrapper Klasse angewendet wird, die von der ApplicationSettingsBase -Klasse abgeleitet wird.The following code example demonstrates the use of the DefaultSettingValueAttribute applied to three of the four properties of the FormSettings wrapper class, which is derived from the ApplicationSettingsBase class. Diese Klasse wird verwendet, um den Speicherort, die Größe, die Hintergrundfarbe und den Text des Formulars beizubehalten.This class is used to persist the location, size, background color, and text of form. Den ersten drei dieser Formular Eigenschaften sind Standardwerte zugeordnet.The first three of these form properties have default values associated with them.

Das vollständige Codebeispiel finden Sie in ApplicationSettingsBase der Übersicht über die-Klasse.The full code example is listed in the ApplicationSettingsBase class overview.

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

DefaultSettingValueAttributekann nur auf einzelne Einstellungs Eigenschaften angewendet werden. Es ist ungültig, dieses Attribut auf eine gesamte Anwendungs Einstellungs Klasse anzuwenden.DefaultSettingValueAttribute can only be applied to individual settings properties; it is invalid to apply this attribute to an entire application settings class.

Unterschiedliche Einstellungs Anbieter haben möglicherweise unterschiedliche Anforderungen oder Einschränkungen für die DefaultSettingValueAttributeVerwendung von.Different settings providers may have different requirements or limitations on the use of the DefaultSettingValueAttribute. Beispielsweise LocalFileSettingsProvider ist dieses Attribut nicht erforderlich, und es wird ein beliebiger von diesem Attribut bereitgestellter Wert überschrieben, wenn im Datenspeicher bereits Werte vorhanden sind (Default oder User-modified).For example, the LocalFileSettingsProvider does not require this attribute, and will override any value provided by this attribute if there are any values - default or user-modified - already present in the data store.

DefaultSettingValueAttributeerfordert, dass der Standardwert als Zeichenfolge dargestellt werden kann.DefaultSettingValueAttribute requires that the default value can be represented as a string. Daher kann für Einstellungen, die die XML-Serialisierung verwenden, kein Standardwert mit diesem Attribut angegeben werden.As a result, settings using XML serialization cannot have a default value specified by means of this attribute. Einige Anbieter unterstützen möglicherweise mehrere Serialisierungsschemas, die zur Kompilierzeit mithilfe SettingsSerializeAsAttributevon angegeben werden können.Some providers may choose to support multiple serialization schemes which can be specified at compile time using the SettingsSerializeAsAttribute.

Achtung

Die Standardwerte, die von diesem Attribut angegeben werden, werden als nur-Text in der resultierenden kompilierten exe-oder DLL-Datei gespeichert.The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Daher sind diese Standardwerte grundsätzlich unsicher.Therefore these default values are inherently insecure.

Konstruktoren

DefaultSettingValueAttribute(String)

Initialisiert eine Instanz der DefaultSettingValueAttribute-Klasse.Initializes an instance of the DefaultSettingValueAttribute class.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)
Value

Ruft den Standardwert für die Anwendungseinstellungseigenschaft ab.Gets the default value for the application settings property.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch