IPersistComponentSettings.SaveSettings Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether the control should automatically persist its application settings properties.

Namespace:   System.Configuration
Assembly:  System (in System.dll)

bool SaveSettings { get; set; }

Property Value

Type: System.Boolean

true if the control should automatically persist its state; otherwise, false.

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. The SaveSettings property determines whether a control automatically persists its configuration data when it is disposed.

The default value of SaveSettings depends on the implementation of the control. 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.

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 {

//...

}

}

.NET Framework
Available since 2.0
Return to top
Show: