.NET 将组合框数据绑定到具有描述属性的字符串枚举

Question

我有一个像这样的枚举：

public enum Cities
{
    [Description("New York City")]
    NewYork,
    [Description("Los Angeles")]
    LosAngeles,
    Washington,
    [Description("San Antonio")]
    SanAntonio,
    Chicago
}

我想将其绑定到组合框，并且我已经尝试过：

comboBox.DataSource = Enum.GetNames(typeof(Cities));

但这显示组合框中的值而不是字符串描述。所以我切换到这个：

public static string GetEnumDescription(Enum value)
{
    FieldInfo fi = value.GetType().GetField(value.ToString());

    DescriptionAttribute[] attributes = (DescriptionAttribute[])fi.GetCustomAttributes(typeof(DescriptionAttribute), false);

    if (attributes != null && attributes.Length > 0)
    {
        return attributes[0].Description;
    }
    else
    {
        return value.ToString();
    }
}

public static IList ToList(this Type type)
{
    ArrayList list = new ArrayList();
    Array enumValues = Enum.GetValues(type);

    foreach (Enum value in enumValues)
    {
        list.Add(new KeyValuePair<Enum, string>(value, GetEnumDescription(value)));
    }

    return list;
}

现在 list.Add() 调用会产生值，并且它的字符串描述显示在组合框中，所以我替换

list.Add(new KeyValuePair<Enum, string>(value, GetEnumDescription(value)));

为

list.Add(GetEnumDescription(value));

，现在我只得到组合框中显示的描述性字符串，这就是我最终的 结果想。现在我的数据绑定已损坏，因为它无法在枚举中找到字符串描述。我认为这可能与combobox.DisplayMember和combobox.ValueMember有关，但我还无法解决这个问题。谁能告诉我到底如何显示描述性字符串，但让我的数据绑定使用该值进行存储等？谢谢你！！！

Answer 1

让我们回到你的问题，我回答了一些几天前并修改它以满足您的新要求。因此，我将保留 colorEnum 示例来代替此问题中的 Cities 枚举。

您已经完成了大部分工作 - 您已经获得了从枚举到描述字符串的代码；现在你只需要从另一条路回去。

public static class EnumHelper
{
    // your enum->string method (I just decluttered it a bit :))
    public static string GetEnumDescription(Enum value)
    {
        var fi = value.GetType().GetField(value.ToString());
        var attributes = fi.GetCustomAttributes(typeof(DescriptionAttribute), false);

        if (attributes.Length > 0)
            return ((DescriptionAttribute)attributes[0]).Description;
        else
            return value.ToString();        
    }

    // the method to go from string->enum
    public static T GetEnumFromDescription<T>(string stringValue)
        where T : struct
    {
        foreach (object e in Enum.GetValues(typeof(T)))           
            if (GetEnumDescription((Enum)e).Equals(stringValue))
                return (T)e;
        throw new ArgumentException("No matching enum value found.");
    }

    // and a method to get a list of string values - no KeyValuePair needed
    public static IEnumerable<string> GetEnumDescriptions(Type enumType)
    {
        var strings = new Collection<string>();
        foreach (Enum e in Enum.GetValues(enumType))   
            strings.Add(GetEnumDescription(e));
        return strings;
    }
}

现在，将几天前的内容...

public class Person 
{
    [...]
    public colorEnum FavoriteColor { get; set; }
    public string FavoriteColorString
    {
        get { return FavoriteColor.ToString(); }
        set { FavoriteColor = (colorEnum)Enum.Parse(typeof(colorEnum), value);  }
    }
}

并将其更改为：

public class Person 
{
    [...]
    public colorEnum FavoriteColor { get; set; }
    public string FavoriteColorString
    {
        get { return EnumHelper.GetEnumDescription(FavoriteColor); }
        set { FavoriteColor = EnumHelper.GetEnumFromDescription<colorEnum>(value); }
    }
}

像以前一样，您将组合框 SelectedItem 值绑定到 FavoriteColorString。如果您仍然像在另一个问题中那样使用 BindingSource（我假设您是这样），则不需要设置 DisplayMember 或 ValueMember 属性。

并将组合框填充代码从： 更改

comboBoxFavoriteColor.DataSource = Enum.GetNames(typeof(colorEnum));

为

comboBoxFavoriteColor.DataSource = EnumHelper.GetEnumDescriptions(typeof(colorEnum));

现在您拥有世界上最好的。用户看到描述，您的代码包含枚举名称，数据存储包含枚举值。