This documentation is archived and is not being maintained.

IPersistComponentSettings Interface

Defines standard functionality for controls or libraries that store and retrieve application settings.

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

public interface IPersistComponentSettings

The IPersistComponentSettings type exposes the following members.

Public propertySaveSettingsGets or sets a value indicating whether the control should automatically persist its application settings properties.
Public propertySettingsKeyGets or sets the value of the application settings key for the current instance of the control.

Public methodLoadComponentSettingsReads the control's application settings into their corresponding properties and updates the control's state.
Public methodResetComponentSettingsResets the control's application settings properties to their default values.
Public methodSaveComponentSettingsPersists the control's application settings properties.

Typically, you can add application settings support to an application by creating a settings wrapper class, which is derived from ApplicationSettingsBase, and then add special properties to this class. However, this approach does not sufficiently encapsulate application settings for a control so that its container is shielded from the details. The IPersistComponentSettings interface provides an application with a standard interface for communicating application settings state change requests to a control, component, or library module. Design-time tools also depend on this interface to properly manage controls and components.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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