DefaultSettingValueAttribute Třída

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.ConfigurationManager.dll

Balíček:

System.Configuration.ConfigurationManager v8.0.0

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 na tři ze čtyř vlastností obálky FormSettings třídy, která je odvozena z ApplicationSettingsBase třídy . Tato třída se používá k zachování umístění, velikosti, barvy pozadí a textu formuláře. První tři z těchto vlastností formuláře mají přidružené 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

Důležité

DefaultSettingValueAttribute lze použít pouze pro jednotlivé vlastnosti nastavení; Není platné použít tento atribut na celou třídu nastavení aplikace.

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

DefaultSettingValueAttribute vyžaduje, aby výchozí hodnota byla reprezentována jako řetězec. V důsledku toho nastavení pomocí serializace XML nemůže mít výchozí hodnotu určenou prostřednictvím tohoto atributu. Někteří zprostředkovatelé mohou zvolit podporu více schémat serializace, které lze zadat v době kompilace SettingsSerializeAsAttributepomocí .

Upozornění

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

DefaultSettingValueAttribute(String)

Inicializuje instanci třídy DefaultSettingValueAttribute.

Vlastnosti

TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)
Value	Získá výchozí hodnotu pro vlastnost nastavení aplikace.

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí hodnotu hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

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