ApplicationSettingsBase.SettingsKey プロパティ

定義

アプリケーション設定グループの設定キーを取得または設定します。Gets or sets the settings key for the application settings group.

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }
member this.SettingsKey : string with get, set
Public Property SettingsKey As String

プロパティ値

現在の設定グループの設定キーを格納している StringA String containing the settings key for the current settings group.

属性

注釈

SettingsKey プロパティは、同じアプリケーション設定クラスの複数のインスタンスを明確に区別するために、クライアントコード (特に設定プロバイダー) を有効にするために用意されています。The SettingsKey property is provided to enable client code, and in particular the settings provider, to disambiguate between multiple instances of the same application settings class.

設定ラッパークラスがシングルトンパターンを使用して設計されていない限り、1つのアプリケーションに同じアプリケーション設定クラスの複数のインスタンスが存在する可能性があります。Unless the settings wrapper class is designed using the singleton pattern, there can be multiple instances of the same application settings class in a single application. SettingsKey の値は、プロパティ値がどのように共有されるかに応じて設定する必要があります。The value of SettingsKey should be set according to how the property values are intended to be shared.

  • ラッパーの設定プロパティが、同じアプリケーション内のラッパーのすべてのインスタンスで共有されることを想定している場合、SettingsKey のすべてのインスタンスで同じ値を持つ必要があります。If the settings properties of the wrapper are intended to be shared across all instances of the wrapper in the same application, then SettingsKey should have the same value in all of the instances. これは、ApplicationSettingsBase クラスの既定の動作です。This is the default behavior of the ApplicationSettingsBase class.

  • ラッパーの設定プロパティがインスタンスごとに使用されることを想定している場合、SettingsKey はすべてのインスタンスに対して一意の値を持つ必要があります。If the settings properties of the wrapper are intended to be per instance, then SettingsKey should have a unique value for every instance. コンストラクターの ApplicationSettingsBase(String) バージョンを使用すると、一意の文字列に SettingsKey を初期化できます。The ApplicationSettingsBase(String) version of the constructor enables you to initialize SettingsKey to a unique string.

これに対し、Context プロパティは、設定プロバイダーにヒントを提供して、効率的で正しい方法で値を永続化できるようにします。In contrast, the Context property provides hints to the settings provider to enable it to persist values in an efficient and orderly manner.

SettingChangingEventArgs クラスには、SettingChanging イベントのソースを特定するのに役立つ類似した SettingKey プロパティが含まれています。The SettingChangingEventArgs class contains a similar SettingKey property that helps identify the source of the SettingChanging event.

適用対象

こちらもご覧ください