mcs/class/System.Web/System.Web.UI/FilterableAttribute.cs

   1 //
   2 // System.Web.UI.FilterableAttribute
   3 //
   4 // Authors:
   5 //      Sanjay Gupta (gsanjay@novell.com)
   6 //
   7 // (C) 2004 Novell, Inc. (http://www.novell.com)
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30 #if NET_2_0
  31 using System;
  32 using System.ComponentModel;
  33
  34 namespace System.Web.UI {
  35         [AttributeUsage (AttributeTargets.Class | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
  36         public sealed class FilterableAttribute : Attribute, IDisposable
  37         {
  38                 private bool filterable;
  39                 private bool dispose;
  40
  41                 public FilterableAttribute (bool filterable)
  42                 {
  43                         this.filterable = filterable;
  44                 }
  45
  46                 public static readonly FilterableAttribute Default = new FilterableAttribute (true);
  47
  48                 public static readonly FilterableAttribute No = new FilterableAttribute (false);
  49
  50                 public static readonly FilterableAttribute Yes = new FilterableAttribute (true);
  51
  52                 public bool Filterable {
  53                         get { return filterable; }
  54                 }
  55
  56                 public void Dispose ()
  57                 {
  58                         Dispose (true);
  59                         GC.SuppressFinalize (this);
  60                 }
  61
  62                 private void Dispose (bool disposing)
  63                 {
  64                         if (!this.dispose) {
  65                                 //Do nothing
  66                                 this.dispose = true;
  67                         }
  68                 }
  69
  70                 public override bool Equals (object obj)
  71                 {
  72                         if (obj != null && obj is FilterableAttribute) {
  73                                 FilterableAttribute fa = (FilterableAttribute) obj;
  74                                 return (this.filterable == fa.filterable);
  75                         }
  76                         return false;
  77                 }
  78
  79                 public override int GetHashCode ()
  80                 {
  81                         return this.filterable.GetHashCode ();
  82                 }
  83
  84                 public override bool IsDefaultAttribute ()
  85                 {
  86                         return Equals (Default);
  87                 }
  88
  89                 public static bool IsObjectFilterable (object obj)
  90                 {
  91                         return IsTypeFilterable (obj.GetType ());
  92                 }
  93
  94                 public static bool IsPropertyFilterable (PropertyDescriptor propDesc)
  95                 {
  96                         System.ComponentModel.AttributeCollection attributes = propDesc.Attributes;
  97                         if (attributes.Count != 0) {
  98                                 foreach (Attribute attrib in attributes)
  99                                         if (attrib is FilterableAttribute)
 100                                                 return true;
 101                         }
 102                         return false;
 103                 }
 104
 105                 public static bool IsTypeFilterable (Type type)
 106                 {
 107                         Object [] attributes = type.GetCustomAttributes (typeof (FilterableAttribute), false);
 108                         if (attributes.Length != 0) {
 109                                 foreach (Attribute attrib in attributes)
 110                                         if (attrib is FilterableAttribute)
 111                                                 return true;
 112                         }
 113                         return false;
 114                 }
 115         }
 116 }
 117 #endif