44 lines
1.8 KiB
C#
44 lines
1.8 KiB
C#
|
//------------------------------------------------------------------------------
|
||
|
|
// <copyright file="IPersistComponentSettings.cs" company="Microsoft">
|
||
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
||
|
|
// </copyright>
|
||
|
|
//------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
namespace System.Configuration {
|
||
|
|
/// <devdoc>
|
||
|
|
/// Components should implement this interface if they want to persist custom settings
|
||
|
|
/// in a hosting application. This interface allows the application author to tell a control
|
||
|
|
/// whether to persist, when to load, save etc.
|
||
|
|
/// </devdoc>
|
||
|
|
public interface IPersistComponentSettings {
|
||
|
|
|
||
|
|
/// <devdoc>
|
||
|
|
/// Indicates to the implementor that settings should be persisted.
|
||
|
|
/// </devdoc>
|
||
|
|
bool SaveSettings { get; set; }
|
||
|
|
|
||
|
|
/// <devdoc>
|
||
|
|
/// Unique key that identifies an individual instance of a settings group(s). This key is needed
|
||
|
|
/// to identify which instance of a component owns a given group(s) of settings. Usually, the component
|
||
|
|
/// will frame its own key, but this property allows the hosting application to override it if necessary.
|
||
|
|
/// </devdoc>
|
||
|
|
string SettingsKey { get; set; }
|
||
|
|
|
||
|
|
/// <devdoc>
|
||
|
|
/// Tells the component to load its settings.
|
||
|
|
/// </devdoc>
|
||
|
|
void LoadComponentSettings();
|
||
|
|
|
||
|
|
/// <devdoc>
|
||
|
|
/// Tells the component to save its settings.
|
||
|
|
/// </devdoc>
|
||
|
|
void SaveComponentSettings();
|
||
|
|
|
||
|
|
/// <devdoc>
|
||
|
|
/// Tells the component to reset its settings. Typically, the component can call Reset on its settings class(es).
|
||
|
|
/// </devdoc>
|
||
|
|
void ResetComponentSettings();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|