IPersistComponentSettings.SaveSettings プロパティ

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

IPersistComponentSettings.SaveSettings プロパティ

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

コントロールのアプリケーション設定プロパティを自動的に保持するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Property SaveSettings As Boolean

Visual Basic (使用法)

Dim instance As IPersistComponentSettings
Dim value As Boolean

value = instance.SaveSettings

instance.SaveSettings = value

C#

bool SaveSettings { get; set;
 }

C++

property bool SaveSettings {
    bool get ();
    void set (bool value);
}

J#

/** @property */
boolean get_SaveSettings ()

/** @property */
void set_SaveSettings (boolean value)

JScript

function get SaveSettings () : boolean

function set SaveSettings (value : boolean)

プロパティ値
コントロールの状態を自動的に保持する場合は true。それ以外の場合は false。

解説

コントロールに構成データが格納されている場合、通常は SaveComponentSettings メソッドの明示的な呼び出しに応答して、また場合によってはコントロールの Dispose メソッドが呼び出されたときに暗黙的に、このデータが保持されます。SaveSettings プロパティは、コントロールの構成データが破棄されたときに、それを自動的に保持するかどうかを決定します。

SaveSettings の既定値は、コントロールの実装によって異なります。コントロールがアプリケーション設定を使用するかどうか、保持されるデータ、および SaveSettings プロパティの既定値については、コントロールのドキュメントを参照してください。

使用例

自動的に構成データを保持する前にコントロールで SaveSettings プロパティの値をチェックする正しい方法を次のコード例に示します。

protected override void Dispose( bool disposing ) {

if(disposing) {

try {

if (SaveSettings) {

SaveComponentSettings();

}

}

finally {

//...

}

}

プラットフォーム

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
Save