File: IPersistSettings.cs

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (43 lines) | stat: -rw-r--r-- 1,840 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
//------------------------------------------------------------------------------
// <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();
    }
}