DefaultSettingValueAttribute Třída

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.ConfigurationManager.dll

Balíček:

System.Configuration.ConfigurationManager v11.0.0-preview.4.26230.115

Zdroj:

DefaultSettingValueAttribute.cs

Určuje výchozí hodnotu vlastnosti nastavení aplikace.

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

Dědičnost

Object

Attribute

DefaultSettingValueAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad kódu ukazuje použití DefaultSettingValueAttribute použité na tři ze čtyř vlastností obálky FormSettings třídy, která je odvozena z ApplicationSettingsBase třídy. Tato třída slouží k zachování umístění, velikosti, barvy pozadí a textu formuláře. První tři z těchto vlastností formuláře mají přiřazené výchozí hodnoty.

Úplný příklad kódu je uveden v přehledu ApplicationSettingsBase třídy.

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

Poznámky

Important

DefaultSettingValueAttribute lze použít pouze u jednotlivých vlastností nastavení; Tento atribut není platný pro použití tohoto atributu pro celou třídu nastavení aplikace.

Různí poskytovatelé nastavení můžou mít různé požadavky nebo omezení týkající se použití DefaultSettingValueAttributerozhraní . Například LocalFileSettingsProvider nevyžaduje tento atribut a přepíše jakoukoli hodnotu poskytnutou tímto atributem, pokud existují nějaké hodnoty – výchozí nebo změněné uživatelem – již v úložišti dat.

DefaultSettingValueAttribute vyžaduje, aby výchozí hodnota byla reprezentována jako řetězec. V důsledku toho nastavení používající serializaci XML nemůže mít výchozí hodnotu určenou pomocí tohoto atributu. Někteří poskytovatelé mohou podporovat více schémat serializace, která lze určit v době kompilace pomocí SettingsSerializeAsAttribute.

Caution

Výchozí hodnoty zadané tímto atributem jsou uloženy jako prostý text ve výsledném kompilovaném .exe nebo .dll souboru. Proto jsou tyto výchozí hodnoty ze své podstaty nezabezpečené.

Konstruktory

Name	Description
DefaultSettingValueAttribute(String)	Inicializuje instanci DefaultSettingValueAttribute třídy.

Vlastnosti

Name	Description
Value	Získá výchozí hodnotu pro vlastnost nastavení aplikace.

Viz také

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Nastavení aplikace pro model Windows Forms