Как использовать перечисление с DescriptionAttribute в asp.net mvc

Ответ 1

Помощник Html EnumDropDownListFor или EnumDropDownList не учитывает атрибуты атрибутов Description для членов enum. Однако, просмотрев исходный код:

Список раскрывающегося списка перечислений: https://aspnetwebstack.codeplex.com/SourceControl/latest#src/System.Web.Mvc/Html/SelectExtensions.cs

Классы помощника Enum: https://aspnetwebstack.codeplex.com/SourceControl/latest#src/System.Web.Mvc/Html/EnumHelper.cs

Классы вспомогательных перечислений выше используются для преобразования enum в List<SelectListItem>. Из приведенного ниже кода:

// Return non-empty name specified in a [Display] attribute for the given field, if any; field name otherwise
private static string GetDisplayName(FieldInfo field)
{
    DisplayAttribute display = field.GetCustomAttribute<DisplayAttribute>(inherit: false);
    if (display != null)
    {
        string name = display.GetName();
        if (!String.IsNullOrEmpty(name))
        {
            return name;
        }
    }

    return field.Name;
}

Вы можете видеть, что в методе GetDisplayName он проверяет существование DisplayAttribute в элементе enum. Если атрибут отображения существует, имя присваивается результату метода DisplayAttribute.GetName().

Объединяя это, мы можем изменить enum, чтобы использовать DisplayAttribute вместо DescriptionAttribute и установить для свойства Name значение, которое вы хотите отобразить.

public enum SearchBy
{
    [Display(Name = "SID/PID")]
    SID = 1,
    [Display(Name = "Name")]
    Name,
    [Display(Name = "Birth Date")]
    DOB,
    [Display(Name = "Cause#")]
    Cause
}

Это даст вам желаемый результат.

Надеюсь, что это поможет.

Ответ 2

Я создал вспомогательный класс, который пытается использовать разные типы атрибутов. Мне это нужно, потому что я использовал bootstrap с https://github.com/civicsource/enums и https://silviomoreto.github.io/bootstrap-select/

public static class EnumHelper<T>
    {
        static EnumHelper()
        {
            var enumType = typeof(T);
            if (!enumType.IsEnum) { throw new ArgumentException("Type '" + enumType.Name + "' is not an enum"); }
        }

        public static string GetEnumDescription(T value)
        {
            var fi = typeof(T).GetField(value.ToString());
            var attributes = (DescriptionAttribute[]) fi.GetCustomAttributes(typeof(DescriptionAttribute), false);
            return attributes.Length > 0 ? attributes[0].Description : value.ToString();
        }

        public static IEnumerable<SelectListItem> GetSelectList()
        {
            var groupDictionary = new Dictionary<string, SelectListGroup>();

            var enumType = typeof(T);
            var fields = from field in enumType.GetFields()
                         where field.IsLiteral
                         select field;

            foreach (var field in fields)
            {
                var display = field.GetCustomAttribute<DisplayAttribute>(false);
                var description = field.GetCustomAttribute<DescriptionAttribute>(false);
                var group = field.GetCustomAttribute<CategoryAttribute>(false);

                var text = display?.GetName() ?? display?.GetShortName() ?? display?.GetDescription() ?? display?.GetPrompt() ?? description?.Description ?? field.Name;
                var value = field.Name;
                var groupName = display?.GetGroupName() ?? group?.Category ?? string.Empty;
                if (!groupDictionary.ContainsKey(groupName)) { groupDictionary.Add(groupName, new SelectListGroup { Name = groupName }); }

                yield return new SelectListItem
                {
                    Text = text,
                    Value = value,
                    Group = groupDictionary[groupName],
                };
            }
        }
    }

И вы называете это так:

<div class="form-group">
   @Html.LabelFor(model => model.Address.State, htmlAttributes: new { @class = "control-label col-md-2" })
   <div class="col-sm-4">
      @Html.DropDownListFor(model => model.Address.State, EnumHelper<StateProvince>.GetSelectList(), new { @class = "selectpicker show-menu-arrow", data_live_search = "true" })
      @Html.ValidationMessageFor(model => model.Address.State, "", new { @class = "text-danger" })
   </div>
</div>

Ответ 3

Учитывая:

public enum MyEnum
{
    [Description("This is the description if my member A")]
    A,
    [Description("This is the description if my member B")]
    B
}

Я лично использую этот метод расширения, чтобы получить описание из моего перечисления:

 public static string GetDescription(this 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();
            }
        }

Чтобы использовать его:

MyEnum.A.GetDescription();

Надеюсь на эту помощь.

Ответ 4

Нет необходимости создавать вспомогательный класс, если вы используете .Net Framework 4.0 или новее.

Вы можете просто использовать атрибут Display в сочетании с EnumDropDownListFor

public enum SearchBy
{
    [Display(Name = "SID/PID")]
    SID = 1,
    [Display(Name = "Name")]
    Name,
    [Display(Name = "Birth Date")]
    DOB,
    [Display(Name = "Cause#")]
    Cause
}

По вашему мнению:

@Html.EnumDropDownListFor(model => model.SearchBy, "Search By", new { @class = "form-control" })

Документация Microsoft:

https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.dataannotations.displayattribute?view=netframework-4.8