IPersistComponentSettings Interface
TOC
Collapse the table of content
Expand the table of content

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

NameDescription
System_CAPS_pubpropertySaveSettings

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

System_CAPS_pubpropertySettingsKey

Gets or sets the value of the application settings key for the current instance of the control.

NameDescription
System_CAPS_pubmethodLoadComponentSettings()

Reads the control's application settings into their corresponding properties and updates the control's state.

System_CAPS_pubmethodResetComponentSettings()

Resets the control's application settings properties to their default values.

System_CAPS_pubmethodSaveComponentSettings()

Persists 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
Available since 2.0
Return to top
Show:
© 2016 Microsoft