[c#] Rappresentazione in serie di un Enum



Answers

Utilizzare il metodo

Enum.GetName(Type MyEnumType,  object enumvariable)  

come in (Assume Shipper è un Enum definito)

Shipper x = Shipper.FederalExpress;
string s = Enum.GetName(typeof(Shipper), x);

Ci sono un sacco di altri metodi statici sulla classe Enum che vale la pena investigare anche ...

Question

Ho il seguente elenco:

public enum AuthenticationMethod
{
    FORMS = 1,
    WINDOWSAUTHENTICATION = 2,
    SINGLESIGNON = 3
}

Il problema però è che ho bisogno della parola "FORMS" quando chiedo AuthenticationMethod.FORMS e non l'id 1.

Ho trovato la seguente soluzione per questo problema ( link ):

Per prima cosa ho bisogno di creare un attributo personalizzato chiamato "StringValue":

public class StringValue : System.Attribute
{
    private readonly string _value;

    public StringValue(string value)
    {
        _value = value;
    }

    public string Value
    {
        get { return _value; }
    }

}

Quindi posso aggiungere questo attributo al mio enumeratore:

public enum AuthenticationMethod
{
    [StringValue("FORMS")]
    FORMS = 1,
    [StringValue("WINDOWS")]
    WINDOWSAUTHENTICATION = 2,
    [StringValue("SSO")]
    SINGLESIGNON = 3
}

E ovviamente ho bisogno di qualcosa per recuperare quello StringValue:

public static class StringEnum
{
    public static string GetStringValue(Enum value)
    {
        string output = null;
        Type type = value.GetType();

        //Check first in our cached results...

        //Look for our 'StringValueAttribute' 

        //in the field's custom attributes

        FieldInfo fi = type.GetField(value.ToString());
        StringValue[] attrs =
           fi.GetCustomAttributes(typeof(StringValue),
                                   false) as StringValue[];
        if (attrs.Length > 0)
        {
            output = attrs[0].Value;
        }

        return output;
    }
}

Bene, ora ho gli strumenti per ottenere un valore stringa per un enumeratore. Posso quindi usarlo in questo modo:

string valueOfAuthenticationMethod = StringEnum.GetStringValue(AuthenticationMethod.FORMS);

Okay, ora funzionano tutti come un incantesimo ma trovo molto lavoro. Mi stavo chiedendo se c'è una soluzione migliore per questo.

Ho anche provato qualcosa con un dizionario e le proprietà statiche, ma non era neanche meglio.




Basta usare il metodo ToString()

public enum any{Tomato=0,Melon,Watermelon}

Per fare riferimento alla stringa Tomato , basta usare

any.Tomato.ToString();



My answer, working on @user29964 's answer (which is by far the simplest and closest to a Enum) is

 public class StringValue : System.Attribute
    {
        private string _value;

        public StringValue(string value)
        {
            _value = value;
        }

        public string Value
        {
            get { return _value; }
        }



        public static string GetStringValue(Enum Flagvalue)
        {
            Type type = Flagvalue.GetType();
            string[] flags = Flagvalue.ToString().Split(',').Select(x => x.Trim()).ToArray();
            List<string> values = new List<string>();

            for (int i = 0; i < flags.Length; i++)
            {

                FieldInfo fi = type.GetField(flags[i].ToString());

                StringValue[] attrs =
                   fi.GetCustomAttributes(typeof(StringValue),
                                           false) as StringValue[];
                if (attrs.Length > 0)
                {
                    values.Add(attrs[0].Value);
                }
            }
            return String.Join(",", values);

        }

uso

[Flags]
    public enum CompeteMetric
    {

        /// <summary>
        /// u
        /// </summary>
        [StringValue("u")]//Json mapping
        Basic_UniqueVisitors = 1 //Basic
             ,
        /// <summary>
        /// vi
        /// </summary>
        [StringValue("vi")]//json mapping
        Basic_Visits = 2// Basic
            ,
        /// <summary>
        /// rank
        /// </summary>
        [StringValue("rank")]//json mapping
        Basic_Rank = 4//Basic
 }

Esempio

        CompeteMetric metrics = CompeteMetric.Basic_Visits | CompeteMetric.Basic_Rank;
        string strmetrics = StringValue.GetStringValue(metrics);

this will return "vi,rank"




Soluzione molto semplice con .Net 4.0 e versioni successive. Non è necessario nessun altro codice

public enum MyStatus
{
    Active = 1,
    Archived = 2
}

Per ottenere la stringa basta usare:

MyStatus.Active.ToString("f");

o

MyStatus.Archived.ToString("f");`

Il valore sarà "Attivo" o "Archiviato".

Per vedere i diversi formati di stringa (la "f" di sopra) quando si chiama Enum.ToString vedere questa pagina Stringhe di formato di enumerazione




A lot of great answers here but in my case did not solve what I wanted out of an "string enum", which was:

  1. Usable in a switch statement eg switch(myEnum)
  2. Can be used in function parameters eg foo(myEnum type)
  3. Can be referenced eg myEnum.FirstElement
  4. I can use strings eg foo("FirstElement") == foo(myEnum.FirstElement)

1,2 & 4 can actually be solved with a C# Typedef of a string (since strings are switchable in c#)

3 can be solved by static const strings. So if you have the same needs, this is the simplest approach:

public sealed class Types
{

    private readonly String name;

    private Types(String name)
    {
        this.name = name;

    }

    public override String ToString()
    {
        return name;
    }

    public static implicit operator Types(string str)
    {
        return new Types(str);

    }
    public static implicit operator string(Types str)
    {
        return str.ToString();
    }


    #region enum

    public const string DataType = "Data";
    public const string ImageType = "Image";
    public const string Folder = "Folder";
    #endregion

}

This allows for example:

    public TypeArgs(Types SelectedType)
    {
        Types SelectedType = SelectedType
    }

e

public TypeObject CreateType(Types type)
    {
        switch (type)
        {

            case Types.ImageType:
              //
                break;

            case Types.DataType:
             //
                break;

        }
    }

Where CreateType can be called with a string or a type. However the downside is that any string is automatically a valid enum , this could be modified but then it would require some kind of init function...or possibly make they explicit cast internal?

Now if an int value was important to you (perhaps for comparison speed), you could use some ideas from Jakub Šturc fantastic answer and do something a bit crazy, this is my stab at it:

    public sealed class Types
{
    private static readonly Dictionary<string, Types> strInstance = new Dictionary<string, Types>();
    private static readonly Dictionary<int, Types> intInstance = new Dictionary<int, Types>();

    private readonly String name;
    private static int layerTypeCount = 0;
    private int value;
    private Types(String name)
    {
        this.name = name;
        value = layerTypeCount++;
        strInstance[name] = this;
        intInstance[value] = this;
    }

    public override String ToString()
    {
        return name;
    }


    public static implicit operator Types(int val)
    {
        Types result;
        if (intInstance.TryGetValue(val, out result))
            return result;
        else
            throw new InvalidCastException();
    }

    public static implicit operator Types(string str)
    {
        Types result;
        if (strInstance.TryGetValue(str, out result))
        {
            return result;
        }
        else
        {
            result = new Types(str);
            return result;
        }

    }
    public static implicit operator string(Types str)
    {
        return str.ToString();
    }

    public static bool operator ==(Types a, Types b)
    {
        return a.value == b.value;
    }
    public static bool operator !=(Types a, Types b)
    {
        return a.value != b.value;
    }

    #region enum

    public const string DataType = "Data";
    public const string ImageType = "Image";

    #endregion

}

but of course "Types bob = 4;" would be meaningless unless you had initialized them first which would sort of defeat the point...

But in theory TypeA == TypeB would be quicker...




Uso una combinazione di molti dei suggerimenti sopra, combinati con alcuni caching. Ora, ho avuto l'idea da un codice che ho trovato da qualche parte sulla rete, ma non riesco a ricordare dove l'ho preso o trovato. Quindi, se qualcuno trova qualcosa che sembra simile, per favore commenta con l'attribuzione.

Ad ogni modo, l'utilizzo coinvolge i convertitori di tipi, quindi se si sta vincolando all'interfaccia utente 'funziona'. È possibile estendere con il pattern di Jakub per la ricerca rapida del codice inizializzando dal convertitore di tipi nei metodi statici.

L'utilizzo di base sarebbe simile a questo

[TypeConverter(typeof(CustomEnumTypeConverter<MyEnum>))]
public enum MyEnum
{
    // The custom type converter will use the description attribute
    [Description("A custom description")]
    ValueWithCustomDescription,

   // This will be exposed exactly.
   Exact
}

Il codice per il convertitore di tipo enum personalizzato segue:

public class CustomEnumTypeConverter<T> : EnumConverter
    where T : struct
{
    private static readonly Dictionary<T,string> s_toString = 
      new Dictionary<T, string>();

    private static readonly Dictionary<string, T> s_toValue = 
      new Dictionary<string, T>();

    private static bool s_isInitialized;

    static CustomEnumTypeConverter()
    {
        System.Diagnostics.Debug.Assert(typeof(T).IsEnum,
          "The custom enum class must be used with an enum type.");
    }

    public CustomEnumTypeConverter() : base(typeof(T))
    {
        if (!s_isInitialized)
        {
            Initialize();
            s_isInitialized = true;
        }
    }

    protected void Initialize()
    {
        foreach (T item in Enum.GetValues(typeof(T)))
        {
            string description = GetDescription(item);
            s_toString[item] = description;
            s_toValue[description] = item;
        }
    }

    private static string GetDescription(T optionValue)
    {
        var optionDescription = optionValue.ToString();
        var optionInfo = typeof(T).GetField(optionDescription);
        if (Attribute.IsDefined(optionInfo, typeof(DescriptionAttribute)))
        {
            var attribute = 
              (DescriptionAttribute)Attribute.
                 GetCustomAttribute(optionInfo, typeof(DescriptionAttribute));
            return attribute.Description;
        }
        return optionDescription;
    }

    public override object ConvertTo(ITypeDescriptorContext context, 
       System.Globalization.CultureInfo culture, 
       object value, Type destinationType)
    {
        var optionValue = (T)value;

        if (destinationType == typeof(string) && 
            s_toString.ContainsKey(optionValue))
        {
            return s_toString[optionValue];
        }

        return base.ConvertTo(context, culture, value, destinationType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, 
       System.Globalization.CultureInfo culture, object value)
    {
        var stringValue = value as string;

        if (!string.IsNullOrEmpty(stringValue) && s_toValue.ContainsKey(stringValue))
        {
            return s_toValue[stringValue];
        }

        return base.ConvertFrom(context, culture, value);
    }
}

}




If you think about the problem we're trying to solve, it's not an enum we need at all. We need an object that allows a certain number of values to be associated with eachother; in other words, to define a class.

Jakub Šturc's type-safe enum pattern is the best option I see here.

Look at it:

  • It has a private constructor so only the class itself can define the allowed values.
  • It is a sealed class so values can't be modifed through inheritence.
  • It is type-safe, allowing your methods to require only that type.
  • There is no reflection performance hit incurred by accessing the values.
  • And lastly, it can be modified to associate more than two fields together, for example a Name, Description, and a numeric Value.



Nella tua domanda non hai mai detto che hai effettivamente bisogno del valore numerico dell'enum ovunque.

Se non lo fai e hai solo bisogno di un enum di tipo string (che non è un tipo integrale quindi non può essere una base di enum) ecco un modo:

    static class AuthenticationMethod
    {
        public static readonly string
            FORMS = "Forms",
            WINDOWSAUTHENTICATION = "WindowsAuthentication";
    }

puoi usare la stessa sintassi di enum per farvi riferimento

if (bla == AuthenticationMethod.FORMS)

Sarà un po 'più lento rispetto ai valori numerici (confrontando le stringhe al posto dei numeri) ma sul lato positivo non sta usando il reflection (slow) per accedere alla stringa.




Sono d'accordo con Keith, ma non posso votare (ancora).

Uso un metodo statico e un'istruzione swith per restituire esattamente ciò che voglio. Nel database memorizzo tinyint e il mio codice utilizza solo l'enum effettivo, quindi le stringhe sono per i requisiti dell'interfaccia utente. Dopo numerosi test, ciò ha prodotto le migliori prestazioni e il massimo controllo sull'output.

public static string ToSimpleString(this enum)
{
     switch (enum)
     {
         case ComplexForms:
             return "ComplexForms";
             break;
     }
}

public static string ToFormattedString(this enum)
{
     switch (enum)
     {
         case ComplexForms:
             return "Complex Forms";
             break;
     }
}

Tuttavia, da alcuni account, questo porta a un possibile incubo di manutenzione e qualche odore di codice. Cerco di tenere d'occhio le enumerazioni che sono lunghe e molte enumerazioni, o quelle che cambiano frequentemente. Altrimenti, questa è stata una grande soluzione per me.




La mia variante

public struct Colors
{
    private String current;

    private static string red = "#ff0000";
    private static string green = "#00ff00";
    private static string blue = "#0000ff";

    private static IList<String> possibleColors; 

    public static Colors Red { get { return (Colors) red; } }
    public static Colors Green { get { return (Colors) green; } }
    public static Colors Blue { get { return (Colors) blue; } }

    static Colors()
    {
        possibleColors = new List<string>() {red, green, blue};
    }

    public static explicit operator String(Colors value)
    {
        return value.current;
    }

    public static explicit operator Colors(String value)
    {
        if (!possibleColors.Contains(value))
        {
            throw new InvalidCastException();
        }

        Colors color = new Colors();
        color.current = value;
        return color;
    }

    public static bool operator ==(Colors left, Colors right)
    {
        return left.current == right.current;
    }

    public static bool operator !=(Colors left, Colors right)
    {
        return left.current != right.current;
    }

    public bool Equals(Colors other)
    {
        return Equals(other.current, current);
    }

    public override bool Equals(object obj)
    {
        if (ReferenceEquals(null, obj)) return false;
        if (obj.GetType() != typeof(Colors)) return false;
        return Equals((Colors)obj);
    }

    public override int GetHashCode()
    {
        return (current != null ? current.GetHashCode() : 0);
    }

    public override string ToString()
    {
        return current;
    }
}

Code looks a bit ugly, but usages of this struct are pretty presentative.

Colors color1 = Colors.Red;
Console.WriteLine(color1); // #ff0000

Colors color2 = (Colors) "#00ff00";
Console.WriteLine(color2); // #00ff00

// Colors color3 = "#0000ff"; // Compilation error
// String color4 = Colors.Red; // Compilation error

Colors color5 = (Colors)"#ff0000";
Console.WriteLine(color1 == color5); // True

Colors color6 = (Colors)"#00ff00";
Console.WriteLine(color1 == color6); // False

Also, I think, if a lot of such enums required, code generation (eg T4) might be used.




Here is yet another way to accomplish the task of associating strings with enums:

struct DATABASE {
    public enum enums {NOTCONNECTED, CONNECTED, ERROR}
    static List<string> strings =
        new List<string>() {"Not Connected", "Connected", "Error"};

    public string GetString(DATABASE.enums value) {
        return strings[(int)value];
    }
}

This method is called like this:

public FormMain() {
    DATABASE dbEnum;

    string enumName = dbEnum.GetString(DATABASE.enums.NOTCONNECTED);
}

You can group related enums in their own struct. Since this method uses the enum type, you can use Intellisense to display the list of enums when making the GetString() call.

You can optionally use the new operator on the DATABASE struct. Not using it means the strings List is not allocated until the first GetString() call is made.




old post but...

The answer to this may actually be very simple. Use Enum.ToString() function

There are 6 overloads of this function, you can use Enum.Tostring("F") or Enum.ToString() to return the string value. No need to bother with anything else. Here is a working Demo

Note that this solution may not work for all compilers ( this demo does not work as expected ) but at least it works for the latest compiler.




Purtroppo la riflessione per ottenere attributi sull'enumerazione è piuttosto lenta:

Vedi questa domanda: Qualcuno conosce un modo rapido per ottenere attributi personalizzati su un valore enum?

Anche .ToString() è piuttosto lento sulle enumerazioni.

Tuttavia, puoi scrivere i metodi di estensione per enumerati:

public static string GetName( this MyEnum input ) {
    switch ( input ) {
        case MyEnum.WINDOWSAUTHENTICATION:
            return "Windows";
        //and so on
    }
}

Questo non è eccezionale, ma sarà veloce e non richiederà la riflessione per gli attributi o il nome del campo.

Aggiornamento C # 6

Se è possibile utilizzare C # 6, il nuovo operatore nameof funziona per enumerazioni, quindi nameof(MyEnum.WINDOWSAUTHENTICATION) verrà convertito in "WINDOWSAUTHENTICATION" in fase di compilazione , rendendolo il modo più rapido per ottenere i nomi enum.

Nota che questo convertirà l'enum esplicito in una costante in linea, quindi non funziona per le enumerazioni che hai in una variabile. Così:

nameof(AuthenticationMethod.FORMS) == "FORMS"

Ma...

var myMethod = AuthenticationMethod.FORMS;
nameof(myMethod) == "myMethod"



Well, after reading all of the above I feel that the guys have over complicated the issue of transforming enumerators into strings. I liked the idea of having attributes over enumerated fields but i think that attributes are mainly used for Meta-data, but in your case i think that all you need is some sort of localization.

public enum Color 
{ Red = 1, Green = 2, Blue = 3}


public static EnumUtils 
{
   public static string GetEnumResourceString(object enumValue)
    {
        Type enumType = enumValue.GetType();
        string value = Enum.GetName(enumValue.GetType(), enumValue);
        string resourceKey = String.Format("{0}_{1}", enumType.Name, value);
        string result = Resources.Enums.ResourceManager.GetString(resourceKey);
        if (string.IsNullOrEmpty(result))
        {
            result = String.Format("{0}", value);
        }
        return result;
    }
}

Now if we try to call the above method we can call it this way

public void Foo()
{
  var col = Color.Red;
  Console.WriteLine (EnumUtils.GetEnumResourceString (col));
}

All you need to do is just create a resource file containing all the enumerator values and the corresponding strings

Resource Name          Resource Value
Color_Red              My String Color in Red
Color_Blue             Blueeey
Color_Green            Hulk Color

What is actually very nice about that is that it will be very helpful if you need your application to be localized, since all you need to do is just create another resource file with your new language! and Voe-la!




Quando mi trovo di fronte a questo problema, ci sono un paio di domande che cerco di trovare prima le risposte:

  • I nomi dei miei valori enumerati sono sufficientemente amichevoli per lo scopo, o devo fornire dei più amichevoli?
  • Devo fare il viaggio di andata e ritorno? Cioè, dovrò prendere i valori del testo e analizzarli in valori enum?
  • È qualcosa che devo fare per molte enumerazioni nel mio progetto, o solo uno?
  • In che tipo di elementi dell'interfaccia utente presenterò queste informazioni - in particolare, sarò vincolante per l'interfaccia utente o utilizzando le finestre delle proprietà?
  • Questo deve essere localizzabile?

Il modo più semplice per eseguire questa operazione è con Enum.GetValue (e supporta il round-trip usando Enum.Parse ). Vale anche la pena di costruire un TypeConverter , come suggerisce Steve Mitcham, per supportare l'UI binding. (Non è necessario creare un TypeConverter quando si usano i fogli di proprietà, che è una delle cose carine sui fogli delle proprietà, anche se il signore sa di avere i propri problemi).

In generale, se le risposte alle domande precedenti suggeriscono che non funzionerà, il mio prossimo passo è creare e compilare un Dictionary<MyEnum, string> statico Dictionary<MyEnum, string> , o possibilmente un Dictionary<Type, Dictionary<int, string>> . Tendo a saltare il passo intermedio decorare-il-codice-con-attributi perché quello che di solito viene giù dal luccio è la necessità di cambiare i valori amichevoli dopo l'implementazione (spesso, ma non sempre, a causa della localizzazione).






Links



Tags

c# c#   enums