Export (0) Print
Expand All

IPersistComponentSettings.SaveSettings Property

Note: This property is new in the .NET Framework version 2.0.

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 */
boolean get_SaveSettings ()

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

function get SaveSettings () : boolean

function set SaveSettings (value : boolean)

Property Value

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 {

//...

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft