ApplicationSettingsBase.SettingsKey プロパティ

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

ApplicationSettingsBase.SettingsKey プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

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

Visual Basic (宣言)

Public Property SettingsKey As
 String

Visual Basic (使用法)

Dim instance As ApplicationSettingsBase
Dim value As String

value = instance.SettingsKey

instance.SettingsKey = value

C#

public string SettingsKey { get;
 set; }

C++

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

J#

/** @property */
public String get_SettingsKey ()

/** @property */
public void set_SettingsKey (String value)

JScript

public function get SettingsKey
 () : String

public function set SettingsKey
 (value : String)

プロパティ値
現在の設定グループの設定キーを格納している String。

解説

SettingsKey プロパティは、クライアント コードおよび特に設定プロバイダが、同じアプリケーション設定クラスの複数のインスタンスを明確に区別できるようにするために用意されています。

設定ラッパー クラスが単一のパターンを使用してデザインされている場合を除き、単一アプリケーションに、同じアプリケーション設定クラスの複数のインスタンスを含めることができます。SettingsKey の値は、プロパティ値を共有する方法に従って設定する必要があります。

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

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

一方、Context プロパティは、設定プロバイダが順序立てられた効率的な方法で値を保持できるようにするためのヒントを提供します。

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ApplicationSettingsBase クラス
ApplicationSettingsBase メンバ
System.Configuration 名前空間
ApplicationSettingsBase.Context プロパティ
SettingChangingEventArgs