EnumDescConverter.cs

/******
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
******/

/*****************************************************************
 * Module: EnumDescConverter.cs
 * Type: C# Source Code
 * Version: 1.0
 * Description: Enum Converter using Description Attributes
 * 
 * Revisions
 * ------------------------------------------------
 * [F] 24/02/2004, Jcl - Shaping up
 * [B] 25/02/2004, Jcl - Made it much easier :-)
 * 
 *****************************************************************/

using System;
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Design;
using System.Reflection;

namespace mhora
{
  /// <summary>
  /// EnumConverter supporting System.ComponentModel.DescriptionAttribute
  /// </summary>
  public class EnumDescConverter : System.ComponentModel.EnumConverter
  {
    protected System.Type myVal;

    /// <summary>
    /// Gets Enum Value's Description Attribute
    /// </summary>
    /// <param name="value">The value you want the description attribute for</param>
    /// <returns>The description, if any, else it's .ToString()</returns>
    public static string GetEnumDescription(Enum value)
    {
      FieldInfo fi= value.GetType().GetField(value.ToString()); 
      DescriptionAttribute[] attributes = 
        (DescriptionAttribute[])fi.GetCustomAttributes(
        typeof(DescriptionAttribute), false);
      return (attributes.Length>0)?attributes[0].Description:value.ToString();
    }
    
    /// <summary>
    /// Gets the description for certaing named value in an Enumeration
    /// </summary>
    /// <param name="value">The type of the Enumeration</param>
    /// <param name="name">The name of the Enumeration value</param>
    /// <returns>The description, if any, else the passed name</returns>
    public static string GetEnumDescription(System.Type value, string name)
    {
      FieldInfo fi= value.GetField(name); 
      DescriptionAttribute[] attributes = 
        (DescriptionAttribute[])fi.GetCustomAttributes(
        typeof(DescriptionAttribute), false);
      return (attributes.Length>0)?attributes[0].Description:name;
    }
    
    /// <summary>
    /// Gets the value of an Enum, based on it's Description Attribute or named value
    /// </summary>
    /// <param name="value">The Enum type</param>
    /// <param name="description">The description or name of the element</param>
    /// <returns>The value, or the passed in description, if it was not found</returns>
    public static object GetEnumValue(System.Type value, string description)
    {
      FieldInfo [] fis = value.GetFields();
      foreach(FieldInfo fi in fis) 
      {
        DescriptionAttribute[] attributes = 
          (DescriptionAttribute[])fi.GetCustomAttributes(
          typeof(DescriptionAttribute), false);
        if(attributes.Length>0) 
        {
          if(attributes[0].Description == description)
          {
            return fi.GetValue(fi.Name);
          }
        }
        if(fi.Name == description)
        {
          return fi.GetValue(fi.Name);
        }
      }
      return description;
    }

    public EnumDescConverter(System.Type type) : base(type)
    {
      myVal = type;
    }

    public override object ConvertTo(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value, Type destinationType)
    {
      if(value is Enum && destinationType == typeof(string)) 
      {
        return GetEnumDescription((Enum)value);
      }
      if(value is string && destinationType == typeof(string)) 
      {
        return GetEnumDescription(myVal, (string)value);
      }
      return base.ConvertTo (context, culture, value, destinationType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value)
    {
      if(value is string) 
      {
        return GetEnumValue(myVal, (string)value);        
      }
      if(value is Enum) 
      {
        return GetEnumDescription((Enum)value);        
      }
      return base.ConvertFrom (context, culture, value);
    }
  }
}