DefaultSettingValueAttribute 類別

定義

命名空間:

System.Configuration

組件:

System.Configuration.ConfigurationManager.dll

套件:

System.Configuration.ConfigurationManager v8.0.0

Source:

DefaultSettingValueAttribute.cs

指定應用程式設定屬性的預設值。

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

繼承

Object

Attribute

DefaultSettingValueAttribute

屬性

AttributeUsageAttribute

範例

下列程式碼範例示範如何使用 DefaultSettingValueAttribute 套用至包裝函式類別的四個屬性 FormSettings 之三，其衍生自 ApplicationSettingsBase 類別。 這個類別用來保存表單的位置、大小、背景色彩和文字。 這些表單內容的前三個具有相關聯的預設值。

完整的程式碼範例會列在類別概觀中 ApplicationSettingsBase 。

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

備註

重要

DefaultSettingValueAttribute 只能套用至個別設定屬性;將此屬性套用至整個應用程式設定類別無效。

不同的設定提供者在使用 時可能會有不同的需求或限制 DefaultSettingValueAttribute 。 例如， LocalFileSettingsProvider 不需要這個屬性，而且如果資料存放區中有任何值 -預設值或使用者修改 ，則會覆寫這個屬性所提供的任何值。

DefaultSettingValueAttribute 要求預設值可以表示為字串。 因此，使用 XML 序列化的設定不能透過這個屬性指定預設值。 某些提供者可以選擇支援多個序列化配置，這些配置可以在編譯時期使用 SettingsSerializeAsAttribute 來指定。

警告

此屬性所指定的預設值會儲存為純文字，並儲存在結果編譯.exe或.dll檔案中。 因此，這些預設值原本就不安全。

建構函式

DefaultSettingValueAttribute(String)

初始化 DefaultSettingValueAttribute 類別的執行個體。

屬性

TypeId	在衍生類別中實作時，取得這個 Attribute 的唯一識別碼。 (繼承來源 Attribute)
Value	取得應用程式設定屬性的預設值。

方法

Equals(Object)	傳回值，這個值指出此執行個體是否與指定的物件相等。 (繼承來源 Attribute)
GetHashCode()	傳回這個執行個體的雜湊碼。 (繼承來源 Attribute)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsDefaultAttribute()	在衍生類別中覆寫時，表示這個執行個體的值是衍生類別的預設值。 (繼承來源 Attribute)
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

另請參閱

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Windows Forms的應用程式設定