Get Enum Description : Enum « Data Types « C# / C Sharp






  1. C# / C Sharp
  2. Data Types
  3. Enum

Get Enum Description

  
//http://facebooktoolkit.codeplex.com/
//http://facebooktoolkit.codeplex.com/license
using System;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Text;

namespace Facebook.Utility
{
  ///<summary>
    /// Contains helper functions used to help when using enums inside of collections and serialization
  ///</summary>
  public class EnumHelper
  {
    private EnumHelper()
    {
    }

    ///<summary>
    ///</summary>
    ///<param name="enumeratedType"></param>
    ///<typeparam name="T"></typeparam>
    ///<returns></returns>
    ///<exception cref="ArgumentException"></exception>
    public static string GetEnumDescription<T>(T enumeratedType)
    {
      var description = enumeratedType.ToString();

      var enumType = typeof (T);
      // Can't use type constraints on value types, so have to do check like this
      if (enumType.BaseType != typeof (Enum))
        throw new ArgumentException("T must be of type System.Enum");

      var fieldInfo = enumeratedType.GetType().GetField(enumeratedType.ToString());

      if (fieldInfo != null)
      {
        var attributes = fieldInfo.GetCustomAttributes(typeof (DescriptionAttribute), false);

        if (attributes != null && attributes.Length > 0)
        {
          description = ((DescriptionAttribute) attributes[0]).Description;
        }
      }

      return description;
    }

    ///<summary>
    ///</summary>
    ///<param name="enums"></param>
    ///<typeparam name="T"></typeparam>
    ///<returns></returns>
    ///<exception cref="ArgumentException"></exception>
    public static string GetEnumCollectionDescription<T>(Collection<T> enums)
    {
      var sb = new StringBuilder();

      var enumType = typeof (T);

      // Can't use type constraints on value types, so have to do check like this
      if (enumType.BaseType != typeof (Enum))
        throw new ArgumentException("T must be of type System.Enum");

      foreach (var enumeratedType in enums)
      {
        sb.AppendLine(GetEnumDescription(enumeratedType));
      }

      return sb.ToString();
    }
  }
}








Related examples in the same category

1.Enumerations:Initialization
2.Enumerations Initialization 2
3.Enumeration Base Types
4.Enum declare and use itEnum declare and use it
5.Demonstrate an enumerationDemonstrate an enumeration
6.Enum by IEnumerable Enum by IEnumerable
7.Enum ValuesEnum Values
8.The use of an enumeration that defines the positions of the planets in the solar system relative to the SunThe use of an enumeration that defines the positions of the planets in the solar system relative to the Sun
9.Illustrates the use of an enumeration that defines the orbital periods of the first four planets in daysIllustrates the use of an enumeration that defines the orbital periods of the first four planets in days
10.Illustrates the use of an enumeration that defines the orbital periods of the first four planets in days, using a base type of longIllustrates the use of an enumeration that defines the orbital periods of the first four planets in days, using a base type of long
11.how a derived class may override an existing enumeration in a base classhow a derived class may override an existing enumeration in a base class
12.A public enum in one class from another classA public enum in one class from another class
13.Demonstrate an enumeratorDemonstrate an enumerator
14.Demonstrate IDictionaryEnumeratorDemonstrate IDictionaryEnumerator
15.Enumerators and ForeachEnumerators and Foreach
16.Enumerations:Bit Flag Enums 1
17.Enumerations:Bit Flag Enums 2
18.Enumerations:The System.Enum TypeEnumerations:The System.Enum Type
19.Enumerations: The System.Enum Type 2Enumerations: The System.Enum Type 2
20.Enum data type comparison
21.Enum.IsDefined()
22.Get all stats for EmpType.
23.Enum Parse
24.Get Enum's type, hex and value.
25.Enum.Format()
26.Get underlying type
27.switch statement with Enum and call its ToString function
28.Format enum value
29.Wrap an enumerable so that clients can't get to the underlying implementation via a down-case
30.Try to parse Enum
31.Enum To Array
32.Convert all Enum value to a List
33.Get all values from an Enum type
34.Get Enum Values
35.Fill all enum value to a List
36.Retrieves the enum field associated with the specified value. A return value indicates whether the conversion succeeded.
37.Provides a description for an enumerated type.
38.Get Description