UserScopedSettingAttributeとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

UserScopedSettingAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

アプリケーション設定グループまたはアプリケーション設定プロパティがアプリケーションのユーザーごとに個別の値を格納するように指定します。このクラスは継承できません。

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class
 UserScopedSettingAttribute
    Inherits SettingAttribute

Visual Basic (使用法)

Dim instance As UserScopedSettingAttribute

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class UserScopedSettingAttribute
 : SettingAttribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class UserScopedSettingAttribute
 sealed : public SettingAttribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class UserScopedSettingAttribute
 extends SettingAttribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public final class UserScopedSettingAttribute
 extends SettingAttribute

解説

アプリケーション設定プロパティのスコープは、アプリケーションレベルまたはユーザーレベルに基づいています。カテゴリが示すように、アプリケーションスコープのプロパティは、アプリケーションのすべてのユーザーに対して同じ値を提供しますが、ユーザースコープのプロパティは、アプリケーションのユーザーごとに個別の値を提供します。

UserScopedSettingAttribute は、プロパティがユーザーレベルの設定と見なされること、およびこれに応じて設定プロバイダが適切なストレージを決定する必要があることを示します。

スコープ属性は、アプリケーション設定プロパティごとに必要です。プロパティに ApplicationScopedSettingAttribute または UserScopedSettingAttribute が適用されない場合、設定プロバイダはそのプロパティを無視し、プロパティはシリアル化されません。ただし、両方の属性を同じ設定プロパティに適用することはできません。両方の属性を適用しようとすると、ConfigurationErrorsException がスローされます。

使用例

ApplicationSettingsBase クラスから派生した FormSettings ラッパークラスの 4 つのプロパティすべてに適用される UserScopedSettingAttribute の使用方法を示すコード例を次に示します。このクラスは、フォームの位置、サイズ、背景色、およびテキストを永続化させるために使用します。完全なコード例は、ApplicationSettingsBase クラスの概要に記載されています。

//Application settings wrapper class
sealed class FormSettings : ApplicationSettingsBase
{
    [UserScopedSettingAttribute()]
    public String FormText
    {
        get { return (String)this["FormText"];
 }
        set { this["FormText"] =
 value; }
    }

    [UserScopedSetting()]
    [DefaultSettingValueAttribute("0, 0")]
    public Point FormLocation
    {
        get { return (Point)(this["FormLocation"]);
 }
        set { this["FormLocation"]
 = value; }
    }

    [UserScopedSetting()]
    [DefaultSettingValueAttribute("225, 200")]
    public Size FormSize
    {
        get { return (Size)this["FormSize"];
 }
        set { this["FormSize"] =
 value; }
    }

    [UserScopedSetting()]
    [DefaultSettingValueAttribute("LightGray")]
    public Color FormBackColor
    {
        get { return (Color)this["FormBackColor"];
 }
        set { this["FormBackColor"]
 = value; }
    }

}

C++

//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:
    [UserScopedSetting()]
    [DefaultSettingValueAttribute("0, 0")]
    property Point FormLocation
    {
        Point get()
        {
            return (Point)(this["FormLocation"]);
        }
        void set( Point value )
        {
            this["FormLocation"] = value;
        }
    }

public:
    [UserScopedSetting()]
    [DefaultSettingValueAttribute("225, 200")]
    property Size FormSize
    {
        Size get()
        {
            return (Size)this["FormSize"];
        }
        void set( Size value )
        {
            this["FormSize"] = value;
        }
    }

public:
    [UserScopedSetting()]
    [DefaultSettingValueAttribute("LightGray")]
    property Color FormBackColor
    {
        Color get()
        {
            return (Color)this["FormBackColor"];
        }
        void set(Color value)
        {
            this["FormBackColor"] = value;
        }
    }

};

継承階層

System.Object
   System.Attribute
     System.Configuration.SettingAttribute
      System.Configuration.UserScopedSettingAttribute

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UserScopedSettingAttribute メンバ
System.Configuration 名前空間
ApplicationScopedSettingAttribute クラス
ApplicationSettingsBase クラス
SettingsProvider クラス
ConfigurationErrorsException クラス
その他の技術情報
アプリケーション設定アーキテクチャ

UserScopedSettingAttribute コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

UserScopedSettingAttribute クラスの新しいインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New UserScopedSettingAttribute

public UserScopedSettingAttribute ()

C++

public:
UserScopedSettingAttribute ()

public UserScopedSettingAttribute ()

JScript

public function UserScopedSettingAttribute
 ()

解説

各アプリケーション設定プロパティは、設定プロバイダによって認識およびシリアル化されるように、単一のスコープ属性を適用する必要があります。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UserScopedSettingAttribute クラス
UserScopedSettingAttribute メンバ
System.Configuration 名前空間
SettingsProvider クラス
その他の技術情報
方法 : デザイナを使用してアプリケーション設定を作成する

UserScopedSettingAttribute プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

その他の技術情報

アプリケーション設定アーキテクチャ

UserScopedSettingAttribute メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュコードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

その他の技術情報

アプリケーション設定アーキテクチャ

UserScopedSettingAttribute メンバ

UserScopedSettingAttribute データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	UserScopedSettingAttribute	UserScopedSettingAttribute クラスの新しいインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュコードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)