ApplicationSettingsBase.SettingsKey プロパティ

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

ApplicationSettingsBase.cs

アプリケーション設定グループの設定キーを取得または設定します。

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.SettingsKey : string with get, set

Public Property SettingsKey As String

プロパティ値

String

現在の設定グループの設定キーを格納している String。

属性

BrowsableAttribute

注釈

プロパティは SettingsKey 、クライアント コード (特に設定プロバイダー) が同じアプリケーション設定クラスの複数のインスタンス間であいまいさを解消できるようにするために提供されます。

設定ラッパー クラスがシングルトン パターンを使用して設計されていない限り、1 つのアプリケーションに同じアプリケーション設定クラスの複数のインスタンスが存在する可能性があります。 の SettingsKey 値は、プロパティ値の共有方法に従って設定する必要があります。

• ラッパーの設定プロパティが同じアプリケーション内のラッパーのすべてのインスタンス間で共有されることを意図している場合は、 SettingsKey すべてのインスタンスで同じ値を持つ必要があります。 これは、 クラスの既定の ApplicationSettingsBase 動作です。

• ラッパーの設定プロパティがインスタンスごとに設定される場合は、 SettingsKey すべてのインスタンスに対して一意の値が必要です。 ApplicationSettingsBase(String)コンストラクターのバージョンを使用すると、一意の文字列に初期化SettingsKeyできます。

これに対し Context 、 プロパティは設定プロバイダーにヒントを提供し、効率的で順序の良い方法で値を保持できるようにします。

クラスには SettingChangingEventArgs 、イベントのソースを識別するのに役立つ同様 SettingKey のプロパティが SettingChanging 含まれています。

こちらもご覧ください

• Context
• SettingChangingEventArgs