class/System/System.ComponentModel.Design/DesignerOptionService.cs

   1 //
   2 // System.ComponentModel.Design.DesignerOptionService
   3 //
   4 // Authors:
   5 //  Ivan N. Zlatev (contact i-nZ.net)
   6 //
   7 // (C) 2006-2007 Ivan N. Zlatev
   8
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29
  30 #if NET_2_0
  31
  32 using System;
  33 using System.Collections;
  34 using System.Globalization;
  35 using System.ComponentModel;
  36
  37 namespace System.ComponentModel.Design
  38 {
  39
  40         public abstract class DesignerOptionService : IDesignerOptionService
  41         {
  42                 [MonoTODO ("implement own TypeConverter")]
  43                 [TypeConverter (typeof (TypeConverter))]
  44                 [Editor ("", "System.Drawing.Design.UITypeEditor, " + Consts.AssemblySystem_Drawing)]
  45                 public sealed class DesignerOptionCollection : IList, ICollection, IEnumerable
  46                 {
  47                         // PropertyDescriptor objects are taken directly from the value passed to the CreateOptionCollection method
  48                         // and are wrapped in an additional property descriptor that hides the value object from the user. This means
  49                         // that any value may be passed into the component parameter of the various PropertyDescriptor methods. The
  50                         // value is not recognized and is replaced with the correct value internally.
  51                         //
  52                         public sealed class WrappedPropertyDescriptor : PropertyDescriptor
  53                         {
  54                                 private PropertyDescriptor _property;
  55                                 private object _component;
  56
  57                                 public WrappedPropertyDescriptor (PropertyDescriptor property, object component) : base (property.Name, new Attribute[0])
  58                                 {
  59                                         _property = property;
  60                                         _component = component;
  61                                 }
  62
  63                                 public override object GetValue (object ignored)
  64                                 {
  65                                         return _property.GetValue (_component);
  66                                 }
  67
  68                                 public override void SetValue (object ignored, object value)
  69                                 {
  70                                         _property.SetValue (_component, value);
  71                                 }
  72
  73                                 public override bool CanResetValue (object ignored)
  74                                 {
  75                                         return _property.CanResetValue (_component);
  76                                 }
  77
  78                                 public override void ResetValue (object ignored)
  79                                 {
  80                                         _property.ResetValue (_component);
  81                                 }
  82
  83                                 public override bool ShouldSerializeValue (object ignored)
  84                                 {
  85                                         return _property.ShouldSerializeValue (_component);
  86                                 }
  87
  88                                 public override AttributeCollection Attributes {
  89                                         get { return _property.Attributes; }
  90                                 }
  91
  92                                 public override bool IsReadOnly {
  93                                         get { return _property.IsReadOnly; }
  94                                 }
  95
  96                                 public override Type ComponentType {
  97                                         get { return _property.ComponentType; }
  98                                 }
  99
 100                                 public override Type PropertyType {
 101                                         get { return _property.PropertyType; }
 102                                 }
 103                         } // WrappedPropertyDescriptor
 104
 105                         private string _name;
 106                         private object _propertiesProvider;
 107                         private DesignerOptionCollection _parent;
 108                         private ArrayList _children;
 109                         private DesignerOptionService _optionService;
 110
 111                         internal DesignerOptionCollection (DesignerOptionCollection parent, string name, object propertiesProvider, DesignerOptionService service)
 112                         {
 113                                 _name = name;
 114                                 _propertiesProvider = propertiesProvider;
 115                                 _parent = parent;
 116
 117                                 if (parent != null) {
 118                                         if (parent._children == null)
 119                                                 parent._children = new ArrayList ();
 120                                         parent._children.Add (this);
 121                                 }
 122
 123                                 _children = new ArrayList ();
 124                                 _optionService = service;
 125                                 service.PopulateOptionCollection (this);
 126                         }
 127
 128                         public bool ShowDialog ()
 129                         {
 130                                 return _optionService.ShowDialog (this, _propertiesProvider);
 131                         }
 132
 133                         public DesignerOptionCollection this[int index] {
 134                                 get { return (DesignerOptionCollection) _children[index]; }
 135                         }
 136
 137                         public DesignerOptionCollection this[string index] {
 138                                 get {
 139                                         foreach (DesignerOptionCollection dc in _children) {
 140                                                 if (String.Compare (dc.Name, index, true, CultureInfo.InvariantCulture) == 0)
 141                                                                 return dc;
 142                                         }
 143                                         return null;
 144                                 }
 145                         }
 146
 147                         public string Name {
 148                                 get { return _name; }
 149                         }
 150
 151                         public int Count {
 152                                 get {
 153                                         if (_children != null)
 154                                                 return _children.Count;
 155                                         return 0;
 156                                 }
 157                         }
 158
 159                         public DesignerOptionCollection Parent {
 160                                 get { return _parent; }
 161                         }
 162
 163                         public PropertyDescriptorCollection Properties {
 164                                 get {
 165                                         // TypeDescriptor.GetProperties gets only the public properties.
 166                                         //
 167                                         PropertyDescriptorCollection properties = TypeDescriptor.GetProperties (_propertiesProvider);
 168                                         ArrayList wrappedProperties = new ArrayList (properties.Count);
 169
 170                                         foreach (PropertyDescriptor pd in properties)
 171                                                 wrappedProperties.Add (new WrappedPropertyDescriptor (pd, _propertiesProvider));
 172
 173                                         PropertyDescriptor[] propertyArray = (PropertyDescriptor[]) wrappedProperties.ToArray (typeof (PropertyDescriptor));
 174                                         return new PropertyDescriptorCollection (propertyArray);
 175                                 }
 176                         }
 177
 178                         public IEnumerator GetEnumerator ()
 179                         {
 180                                 return _children.GetEnumerator ();
 181                         }
 182
 183                         public int IndexOf (DesignerOptionCollection item)
 184                         {
 185                                 return _children.IndexOf (item);
 186                         }
 187
 188                         public void CopyTo (Array array, int index)
 189                         {
 190                                 _children.CopyTo (array, index);
 191                         }
 192
 193                         bool IList.IsFixedSize {
 194                                 get { return true; }
 195                         }
 196
 197                         bool IList.IsReadOnly {
 198                                 get { return true; }
 199                         }
 200
 201                         object IList.this[int index] {
 202                                 get { return this[index]; }
 203                                 set { throw new NotSupportedException (); }
 204                         }
 205
 206                         bool ICollection.IsSynchronized {
 207                                 get { return false; }
 208                         }
 209
 210                         object ICollection.SyncRoot {
 211                                 get { return this; }
 212                         }
 213
 214                         bool IList.Contains (object item)
 215                         {
 216                                 return _children.Contains (item);
 217                         }
 218
 219                         int IList.IndexOf (object item)
 220                         {
 221                                 return _children.IndexOf (item);
 222                         }
 223
 224                         int IList.Add (object item)
 225                         {
 226                                 throw new NotSupportedException ();
 227                         }
 228
 229                         void IList.Remove (object item)
 230                         {
 231                                 throw new NotSupportedException ();
 232                         }
 233
 234                         void IList.RemoveAt (int index)
 235                         {
 236                                 throw new NotSupportedException ();
 237                         }
 238
 239                         void IList.Insert (int index, object item)
 240                         {
 241                                 throw new NotSupportedException ();
 242                         }
 243
 244                         void IList.Clear ()
 245                         {
 246                                 throw new NotSupportedException ();
 247                         }
 248
 249                 } // DesignerOptionCollection
 250
 251
 252                 private DesignerOptionCollection _options;
 253
 254                 protected internal DesignerOptionService ()
 255                 {
 256                 }
 257
 258                 protected DesignerOptionCollection CreateOptionCollection (DesignerOptionCollection parent, string name, Object value)
 259                 {
 260                         if (name == null)
 261                                 throw new ArgumentNullException ("name");
 262                         if (parent == null)
 263                                 throw new ArgumentNullException ("parent");
 264                         if (name == String.Empty)
 265                                 throw new ArgumentException ("name.Length == 0");
 266
 267                         return new DesignerOptionCollection (parent, name, value, this);
 268                 }
 269
 270                 protected virtual bool ShowDialog (DesignerOptionCollection options, object optionObject)
 271                 {
 272                         return false;
 273                 }
 274
 275                 protected virtual void PopulateOptionCollection (DesignerOptionCollection options)
 276                 {
 277                 }
 278
 279                 public DesignerOptionCollection Options {
 280                         get {
 281                                 if (_options == null)
 282                                         _options = new DesignerOptionCollection (null, String.Empty, null, this);
 283
 284                                 return _options;
 285                         }
 286                 }
 287
 288
 289                 object IDesignerOptionService.GetOptionValue (string pageName, string valueName)
 290                 {
 291                         if (pageName == null)
 292                                 throw new ArgumentNullException ("pageName");
 293                         if (valueName == null)
 294                                 throw new ArgumentNullException ("valueName");
 295
 296                         PropertyDescriptor property = GetOptionProperty (pageName, valueName);
 297                         if (property != null)
 298                                 return property.GetValue (null);
 299
 300                         return null;
 301                 }
 302
 303                 void IDesignerOptionService.SetOptionValue (string pageName, string valueName, object value)
 304                 {
 305                         if (pageName == null)
 306                                 throw new ArgumentNullException ("pageName");
 307                         if (valueName == null)
 308                                 throw new ArgumentNullException ("valueName");
 309
 310                         PropertyDescriptor property = GetOptionProperty (pageName, valueName);
 311                         if (property != null)
 312                                 property.SetValue (null, value);
 313                 }
 314
 315                 // Go to the page and get the property associated with the option name.
 316                 //
 317                 private PropertyDescriptor GetOptionProperty (string pageName, string valueName)
 318                 {
 319                         string[] pages = pageName.Split (new char[] { '\\' });
 320
 321                         DesignerOptionCollection options = this.Options;
 322                         foreach (string page in pages) {
 323                                 options = options[page];
 324                                 if (options == null)
 325                                         return null;
 326                         }
 327
 328                         return options.Properties[valueName];
 329                 }
 330
 331         }
 332 }
 333 #endif