.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

让我们回到几天前我answered 的问题，并对其进行修改以适应您的新要求。因此，我将在此问题中保留 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));

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