IPersistComponentSettings.SettingsKey プロパティ

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

IPersistComponentSettings.cs

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

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

public string SettingsKey { get; set; }

member this.SettingsKey : string with get, set

Public Property SettingsKey As String

プロパティ値

String

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

注釈

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

の使用 SettingsKeyには、次の一般的な規則が適用されます。

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

• コントロールは、インスタンスごとのデータとその共有データを異なる設定クラスに分割する必要があります。

• インスタンスごとの構成データを含むコントロールの場合、 get プロパティの SettingsKey アクセサーは既定で コントロールの に Name 設定する必要があります。 ほとんどの場合、コントロールの名前はアプリケーション内で一意になります。 コントロールに共有構成データのみが含まれている場合は、 get 既定で に設定する null必要があります。

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

こちらもご覧ください

• SaveComponentSettings()
• SettingsKey
• カスタム コントロールのアプリケーション設定