class/System/System.ComponentModel/DescriptionAttribute.cs

   1 //
   2 // System.ComponentModel.DescriptionAttribute.cs
   3 //
   4 // Authors:
   5 //   Miguel de Icaza (miguel@ximian.com)
   6 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   7 //
   8 // (C) Ximian, Inc.  http://www.ximian.com
   9 // (C) 2003 Andreas Nahr
  10 //
  11 //
  12
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 namespace System.ComponentModel {
  35
  36         [AttributeUsage (AttributeTargets.All)]
  37         public class DescriptionAttribute : Attribute
  38         {
  39                 private string desc;
  40
  41                 public static readonly DescriptionAttribute Default = new DescriptionAttribute ();
  42
  43                 public DescriptionAttribute ()
  44                 {
  45                         desc = string.Empty;
  46                 }
  47
  48                 public DescriptionAttribute (string name)
  49                 {
  50                         desc = name;
  51                 }
  52
  53                 public virtual string Description {
  54                         get {
  55                                 return DescriptionValue;
  56                         }
  57                 }
  58
  59                 //
  60                 // Notice that the default Description implementation uses this by default
  61                 //
  62                 protected string DescriptionValue {
  63                         get {
  64                                 return desc;
  65                         }
  66
  67                         set {
  68                                 desc = value;
  69                         }
  70                 }
  71
  72                 public override bool Equals (object obj)
  73                 {
  74                         if (!(obj is DescriptionAttribute))
  75                                 return false;
  76                         if (obj == this)
  77                                 return true;
  78                         return ((DescriptionAttribute) obj).Description == desc;
  79                 }
  80
  81                 public override int GetHashCode ()
  82                 {
  83                         return desc.GetHashCode ();
  84                 }
  85
  86 #if NET_2_0
  87                 public override bool IsDefaultAttribute ()
  88                 {
  89                         return this == Default;
  90                 }
  91 #endif
  92         }
  93 }
  94