IPersistComponentSettings.SaveSettings プロパティ

定義

コントロールのアプリケーション設定プロパティを自動的に保持するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the control should automatically persist its application settings properties.

public:
 property bool SaveSettings { bool get(); void set(bool value); };
public bool SaveSettings { get; set; }
member this.SaveSettings : bool with get, set
Public Property SaveSettings As Boolean

プロパティ値

コントロールの状態を自動的に保持する場合は true。それ以外の場合は falsetrue if the control should automatically persist its state; otherwise, false.

次のコード例は、構成データを自動的に永続化する前に、コントロールが SaveSettings プロパティの値を確認するための適切な方法を示しています。The following code example shows the proper way for a control to check the value of the SaveSettings property before it attempts to automatically persist its configuration data.

protected override void Dispose( bool disposing ) {

if(disposing) {

try {

if (SaveSettings) {

SaveComponentSettings();

}

}

finally {

//...

}

}

注釈

コントロールに構成データが含まれている場合、通常は、SaveComponentSettings メソッドへの明示的な呼び出しに応答してこのデータを保持するか、コントロールの Dispose メソッドが呼び出されたときに暗黙的に発生することがあります。If a control contains configuration data, it will typically persist this data in response to an explicit call to the SaveComponentSettings method or sometimes implicitly when the control's Dispose method is invoked. SaveSettings プロパティは、コントロールが破棄されたときに、その構成データを自動的に永続化するかどうかを決定します。The SaveSettings property determines whether a control automatically persists its configuration data when it is disposed.

SaveSettings の既定値は、コントロールの実装によって異なります。The default value of SaveSettings depends on the implementation of the control. コントロールのドキュメントでは、アプリケーション設定、永続化されるデータ、および SaveSettings プロパティの既定値が使用されるかどうかを示す必要があります。The documentation for the control should indicate whether it uses application settings, what data is persisted, and what the default value of the SaveSettings property is.

適用対象

こちらもご覧ください