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-2010 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 using System;
  31 using System.ComponentModel;
  32
  33 namespace System.Web.UI {
  34         [AttributeUsage (AttributeTargets.Class | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
  35         public sealed class FilterableAttribute : Attribute
  36         {
  37                 bool filterable;
  38
  39                 public FilterableAttribute (bool filterable)
  40                 {
  41                         this.filterable = filterable;
  42                 }
  43
  44                 public static readonly FilterableAttribute Default = new FilterableAttribute (true);
  45
  46                 public static readonly FilterableAttribute No = new FilterableAttribute (false);
  47
  48                 public static readonly FilterableAttribute Yes = new FilterableAttribute (true);
  49
  50                 public bool Filterable {
  51                         get { return filterable; }
  52                 }
  53
  54                 public override bool Equals (object obj)
  55                 {
  56                         if (obj != null && obj is FilterableAttribute) {
  57                                 FilterableAttribute fa = (FilterableAttribute) obj;
  58                                 return (this.filterable == fa.filterable);
  59                         }
  60                         return false;
  61                 }
  62
  63                 public override int GetHashCode ()
  64                 {
  65                         return this.filterable.GetHashCode ();
  66                 }
  67
  68                 public override bool IsDefaultAttribute ()
  69                 {
  70                         return Equals (Default);
  71                 }
  72
  73                 public static bool IsObjectFilterable (object obj)
  74                 {
  75                         return IsTypeFilterable (obj.GetType ());
  76                 }
  77
  78                 public static bool IsPropertyFilterable (PropertyDescriptor propDesc)
  79                 {
  80                         System.ComponentModel.AttributeCollection attributes = propDesc.Attributes;
  81                         if (attributes.Count != 0) {
  82                                 foreach (Attribute attrib in attributes)
  83                                         if (attrib is FilterableAttribute)
  84                                                 return true;
  85                         }
  86                         return false;
  87                 }
  88
  89                 public static bool IsTypeFilterable (Type type)
  90                 {
  91                         Object [] attributes = type.GetCustomAttributes (typeof (FilterableAttribute), false);
  92                         if (attributes.Length != 0) {
  93                                 foreach (Attribute attrib in attributes)
  94                                         if (attrib is FilterableAttribute)
  95                                                 return true;
  96                         }
  97                         return false;
  98                 }
  99         }
 100 }