IPersistComponentSettings.SettingsKey プロパティ

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

IPersistComponentSettings.SettingsKey プロパティ

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

コントロールの現在のインスタンスのアプリケーション設定キーの値を取得または設定します。

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

Visual Basic (宣言)

Property SettingsKey As String

Visual Basic (使用法)

Dim instance As IPersistComponentSettings
Dim value As String

value = instance.SettingsKey

instance.SettingsKey = value

C#

string SettingsKey { get; set;
 }

C++

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

J#

/** @property */
String get_SettingsKey ()

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

JScript

function get SettingsKey () : String

function set SettingsKey (value : String)

プロパティ値
コントロールの現在のインスタンスの設定キーを格納している String。

解説

同じラッパー クラスに複数のインスタンスが存在する場合、SettingsKey プロパティを使用して、アプリケーション設定プロパティのグループを明確にします。たとえば、関連付けられているラッパー クラスがコントロールに格納されている場合に、同じアプリケーション内の同じコントロールに複数のインスタンスが配置されると、通常、ラッパー クラスの複数のインスタンスが作成されます。設定キーは、動的に配置されるコントロールの位置など、インスタンスごとに構成データが異なる場合にだけ必要です。

SettingsKey を使用する場合、次の一般的な規則が適用されます。

• コントロールは、クラスと同様、ApplicationSettingsBase から派生した 0 個以上のアプリケーション設定クラスを格納できます。各設定クラスには、独自の ApplicationSettingsBase.SettingsKey プロパティが含まれていて、そのクラスの複数のインスタンスを明確にするために役立ちます。

• コントロールのインスタンスごとのデータおよび共有データは、それぞれ別の設定クラスに分離する必要があります。

• インスタンスごとに構成データが存在するコントロールの場合、SettingsKey プロパティの get アクセサの既定値は、コントロールの Name になります。ほとんどの場合、コントロールの名前は、アプリケーション内で一意です。コントロールに共有構成データだけが格納されている場合、get の既定値は null 参照 (Visual Basic では Nothing) になります。

• このプロパティの set アクセサは、インスタンスごとの構成データが格納されている設定クラスと、共有構成データが格納されている設定クラスを区別するように実装される必要があります。インスタンスごとのデータが格納されている各設定クラスの場合、set は、設定クラスの ApplicationSettingsBase.SettingsKey プロパティにパススルーします。共有データが格納されている設定クラスの場合、set は、その設定クラスに対してアクションを実行しません。

プラットフォーム

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

参照

関連項目
IPersistComponentSettings インターフェイス
IPersistComponentSettings メンバ
System.Configuration 名前空間
SaveComponentSettings
ApplicationSettingsBase.SettingsKey プロパティ
その他の技術情報
カスタム コントロールのアプリケーション設定