DefaultSettingValueAttribute クラス

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

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 4 つのプロパティ FormSettings のうちの 3 つに適用される の使用を ApplicationSettingsBase 示しています。 このクラスは、フォームの場所、サイズ、背景色、テキストを保持するために使用されます。 これらのフォーム プロパティの最初の 3 つには、既定値が関連付けられています。

完全なコード例は、クラスの概要に 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 フォームのアプリケーション設定