2 // System.Web.UI.WebControls.SettingsBase.cs
5 // Chris Toshok (toshok@ximian.com)
7 // (C) 2005 Novell, Inc (http://www.novell.com)
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 using System.Collections;
32 using System.ComponentModel;
34 namespace System.Configuration
37 public abstract class SettingsBase
39 protected SettingsBase ()
43 public void Initialize (SettingsContext context,
44 SettingsPropertyCollection properties,
45 SettingsProviderCollection providers)
47 this.context = context;
48 this.properties = properties;
49 this.providers = providers;
50 // values do not seem to be reset here!! (otherwise one of the SettingsBaseTest will fail)
53 public virtual void Save ()
65 // Copied from ApplicationSettingsBase
67 #if (CONFIGURATION_DEP)
68 /* ew.. this needs to be more efficient */
69 foreach (SettingsProvider provider in Providers) {
70 SettingsPropertyValueCollection cache = new SettingsPropertyValueCollection ();
72 foreach (SettingsPropertyValue val in PropertyValues) {
73 if (val.Property.Provider == provider)
78 provider.SetPropertyValues (Context, cache);
83 public static SettingsBase Synchronized (SettingsBase settingsBase)
85 settingsBase.sync = true;
89 public virtual SettingsContext Context {
90 get { return context; }
94 public bool IsSynchronized {
98 public virtual object this [ string propertyName ] {
103 return GetPropertyValue (propertyName);
106 return GetPropertyValue (propertyName);
112 SetPropertyValue (propertyName, value);
115 SetPropertyValue (propertyName, value);
119 public virtual SettingsPropertyCollection Properties {
121 // It seems that Properties.IsSynchronized is
122 // nothing to do with this.IsSynchronized.
127 public virtual SettingsPropertyValueCollection PropertyValues {
139 public virtual SettingsProviderCollection Providers {
145 object GetPropertyValue (string propertyName)
147 SettingsProperty prop = null;
148 if (Properties == null || (prop = Properties [propertyName]) == null)
149 throw new SettingsPropertyNotFoundException (
150 string.Format ("The settings property '{0}' was not found", propertyName));
152 if (values [propertyName] == null)
153 foreach (SettingsPropertyValue v in prop.Provider.GetPropertyValues (Context, Properties))
156 return PropertyValues [propertyName].PropertyValue;
159 void SetPropertyValue (string propertyName, object value)
161 SettingsProperty prop = null;
162 if (Properties == null || (prop = Properties [propertyName]) == null)
163 throw new SettingsPropertyNotFoundException (
164 string.Format ("The settings property '{0}' was not found", propertyName));
167 throw new SettingsPropertyIsReadOnlyException (
168 string.Format ("The settings property '{0}' is read only", propertyName));
170 if (prop.PropertyType != value.GetType ())
171 throw new SettingsPropertyWrongTypeException (
172 string.Format ("The value supplied is of a type incompatible with the settings property '{0}'", propertyName));
174 PropertyValues [propertyName].PropertyValue = value;
178 SettingsContext context;
179 SettingsPropertyCollection properties;
180 SettingsProviderCollection providers;
181 SettingsPropertyValueCollection values = new SettingsPropertyValueCollection ();