Converting a String to an Enumeration Value

Environment: C#

Introduction

Using enumeration types is the best way to store data such as days, months, account types, genders, and so forth.

Using this technique for data exchange, I decided to use enumerations for external representation as well. There is no problem converting an enumeration type value to a string. You only have to use the standard "ToString()" method for conversion. For example: "string x = DayOfWeek.Monday.ToString()" will place the string "Monday" in "x".

But how do you convert this string back to its internal value? First, I generated a long list of switch and case statements to handle this problem.

Using the System.Reflection class, the solution is placed in just 3–8 lines of code, and it works for any possible enumeration type.

The following example contains the method "StringToEnum" that performs the internal conversions. The other stuff is just to get a small example of how to use "StringToEnum" in your code. The example is based on the well-known enumeration type "System.DayOfWeek", but "StringToEnum" will work for any other enumeration type as well.

Source

using System;
using System.Reflection;

namespace ttype
{
  ///
  /// How to convert a string value to a given enumeration type.
  ///
  /// The static method "StringToEnum" will convert any possible
  /// string value to a given enumeration type. It's a function I
  /// never found in any framework class.
  ///
  class Class1
  {
    static void Main(string[] args)
    {
      // Check all the possible values:
      DayOut( DayOfWeek.Monday );
      DayOut( DayOfWeek.Tuesday );
      DayOut( DayOfWeek.Wednesday );
      DayOut( DayOfWeek.Thursday );
      DayOut( DayOfWeek.Friday );
      DayOut( DayOfWeek.Saturday );
      DayOut( DayOfWeek.Sunday );

      // This would throw an Exception:
      // StringToEnum( typeof(DayOfWeek), "Montag" );
    }

    static void DayOut( DayOfWeek d )
    {
      string myString = d.ToString();

      Console.WriteLine( "{0} = {1} = {2}", d, myString, (int)
                          d );

      // This line can't work because we can't convert "string"
      // to "enum type"
      // Console.WriteLine( "{0} = {1} = {2}", d, myString,
      // (DayOfWeek) myString );

      // This line will not work either:
      // DayOfWeek NewVal1 = (DayOfWeek) Convert.ChangeType
      //                     ( myString, typeof(DayOfWeek) );

      // So we have to use our "StringToEnum" Function:
      DayOfWeek NewVal = (DayOfWeek) StringToEnum
                         ( typeof(DayOfWeek), myString );
      Console.WriteLine( "{0} = {1} = {2}", d, NewVal, (int)
                                               NewVal );
    }

    ///
    /// Convert any possible string-Value of a given enumeration
    /// type to its internal representation.
    ///
    static object StringToEnum( Type t, string Value )
    {
      foreach ( FieldInfo fi in t.GetFields() )
        if ( fi.Name == Value )
          return fi.GetValue( null );    // We use null because
                                         // enumeration values
                                         // are static

      throw new Exception( string.Format("Can't convert {0} to 
                                          {1}", Value,
                                          t.ToString()) );
    }
  }
}

Downloads

Download source - 1 Kb


Comments

  • unknown

    Posted by Legacy on 01/05/2004 12:00am

    Originally posted by: eruch

    dear reader, i have a date field in an access database and i want to convert the dates in ##/##/## format into day of week, so that i can calculate the number of mondays, number of tuesdays, etc...
    
    

    should i query and say something in the design view? say what? how? please help. im lost.

    eruch

    Reply
  • Seek ye .Net

    Posted by Legacy on 03/18/2003 12:00am

    Originally posted by: Troy Kruthoff

    This article is a good example of re-creating the wheel. .Net does so much, yet it can be hard to tell what you need to create and what has been done for you. A good rule of thumb is to look at what .Net does to make serialization work. This has solved many problems for me. i.e., if .Net can serialize an enum to XML and back, then there must already exist a way to do it, outside of switch statements and for loops.
    Troy

    Reply
  • String To Enum Alternative

    Posted by Legacy on 02/22/2003 12:00am

    Originally posted by: Sean

    
    

    Example:

    enum Days { Monday, Wednesday, Friday, Sunday }

    public class Blah
    {
    public static Days getDay(string name)
    {
    Days ret;
    ret = (Days) Days.Parse(typeof(Days), name);
    return ret;
    }
    }

    Reply
  • !

    Posted by Legacy on 11/13/2002 12:00am

    Originally posted by: Goran Mitrovic

    Look at the Enum.Parse method... :)
    

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Learn How A Global Entertainment Company Saw a 448% ROI Every business today uses software to manage systems, deliver products, and empower employees to do their jobs. But software inevitably breaks, and when it does, businesses lose money -- in the form of dissatisfied customers, missed SLAs or lost productivity. PagerDuty, an operations performance platform, solves this problem by helping operations engineers and developers more effectively manage and resolve incidents across a company's global operations. …

  • Live Event Date: December 18, 2014 @ 2:00 p.m. ET / 11:00 a.m. PT The Internet of Things (IoT) incorporates physical devices into business processes using predictive analytics. While it relies heavily on existing Internet technologies, it differs by including physical devices, specialized protocols, physical analytics, and a unique partner network. To capture the real business value of IoT, the industry must move beyond customized projects to general patterns and platforms. Check out this upcoming webcast …

Most Popular Programming Stories

More for Developers

RSS Feeds