Як отримати атрибут відображуваного імені члена Enum через код бритви MVC?


211

У моїй моделі під назвою "Акція" є властивість: її тип - це перелік прапорів під назвою "UserPromotion". Члени мого переліку мають такі атрибути відображення:

[Flags]
public enum UserPromotion
{
    None = 0x0,

    [Display(Name = "Send Job Offers By Mail")]
    SendJobOffersByMail = 0x1,

    [Display(Name = "Send Job Offers By Sms")]
    SendJobOffersBySms = 0x2,

    [Display(Name = "Send Other Stuff By Sms")]
    SendPromotionalBySms = 0x4,

    [Display(Name = "Send Other Stuff By Mail")]
    SendPromotionalByMail = 0x8
}

Тепер я хочу мати змогу створити скажімо ul на мій погляд, щоб показати вибрані значення моєї властивості "Promotion". Це те, що я робив до цих пір, але проблема полягає в тому, як я можу отримати тут відображувані імена?

<ul>
    @foreach (int aPromotion in @Enum.GetValues(typeof(UserPromotion)))
    {
        var currentPromotion = (int)Model.JobSeeker.Promotion;
        if ((currentPromotion & aPromotion) == aPromotion)
        {
        <li>Here I don't know how to get the display attribute of "currentPromotion".</li>
        }
    }
</ul>

12
MVC5 підтримує атрибут DisplayName на переліках.
Барт Калікто

10
Щоб було зрозуміліше: Тільки System.ComponentModel.DataAnnotations.DisplayAttribute. Ні System.ComponentModel.DisplayNameAttribute.
kamranicus

1
Чи включає це використання рефлексії і, отже, впливає на результативність? 'Тому що це буде називатися багато часу.
Ніко

Відповіді:


182

ОНОВЛЕННЯ

Перше рішення було зосереджено на отриманні відображуваних імен від enum. Код нижче повинен бути точним рішенням вашої проблеми.

Ви можете використовувати цей клас помічників для переліків:

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;

public static class EnumHelper<T>
{
    public static IList<T> GetValues(Enum value)
    {
        var enumValues = new List<T>();

        foreach (FieldInfo fi in value.GetType().GetFields(BindingFlags.Static | BindingFlags.Public))
        {
            enumValues.Add((T)Enum.Parse(value.GetType(), fi.Name, false));
        }
        return enumValues;
    }

    public static T Parse(string value)
    {
        return (T)Enum.Parse(typeof(T), value, true);
    }

    public static IList<string> GetNames(Enum value)
    {
        return value.GetType().GetFields(BindingFlags.Static | BindingFlags.Public).Select(fi => fi.Name).ToList();
    }

    public static IList<string> GetDisplayValues(Enum value)
    {
        return GetNames(value).Select(obj => GetDisplayValue(Parse(obj))).ToList();
    }

    private static string lookupResource(Type resourceManagerProvider, string resourceKey)
    {
        foreach (PropertyInfo staticProperty in resourceManagerProvider.GetProperties(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public))
        {
            if (staticProperty.PropertyType == typeof(System.Resources.ResourceManager))
            {
                System.Resources.ResourceManager resourceManager = (System.Resources.ResourceManager)staticProperty.GetValue(null, null);
                return resourceManager.GetString(resourceKey);
            }
        }

        return resourceKey; // Fallback with the key name
    }

    public static string GetDisplayValue(T value)
    {
        var fieldInfo = value.GetType().GetField(value.ToString());

        var descriptionAttributes = fieldInfo.GetCustomAttributes(
            typeof(DisplayAttribute), false) as DisplayAttribute[];

        if (descriptionAttributes[0].ResourceType != null)
            return lookupResource(descriptionAttributes[0].ResourceType, descriptionAttributes[0].Name);

        if (descriptionAttributes == null) return string.Empty;
        return (descriptionAttributes.Length > 0) ? descriptionAttributes[0].Name : value.ToString();
    }
}

Тоді ви можете використовувати його на ваш погляд у такий спосіб:

<ul>
    @foreach (var value in @EnumHelper<UserPromotion>.GetValues(UserPromotion.None))
    {
         if (value == Model.JobSeeker.Promotion)
        {
            var description = EnumHelper<UserPromotion>.GetDisplayValue(value);
            <li>@Html.DisplayFor(e => description )</li>
        }
    }
</ul>

Сподіваюся, це допомагає! :)


8
Усі відповіді використовують .ToString, однак із сайту stackoverflow.com/q/483794/179311 написано використовувати Enum.GetNameзамість цього.
bradlis7

значення.GetType (). GetField (value.ToString ()) саме те, що я шукав!
cdie

Ця відповідь добре з деякими доповненнями перевірок нульових, але якщо ви не використовуєте dotfuscation відповідь на stackoverflow.com/a/4412730/852806 здається простіше.
ХокейJ

5
У GetDisplayValueвас повинен перший тест , descriptionAttributes == nullперш ніж намагатися отримати доступ до масиву: descriptionAttributes[0]. В іншому випадку ви можете підняти виняток, і рядок нижче, де ви перевіряєте на null, ніколи не буде істинним.
Роберт С.

Я б запропонував неповнолітні зміни: публічний статичний IList <T> GetValues ​​(значення Enum) може бути публічним статичним IList <T> GetValues ​​(значення T). EnumHelper <T> to => загальнодоступний статичний клас EnumHelper <T> де T: struct, IConvertible. Можливо статичний кондуктор? статичний EnumHelper () {if (! typeof (T) .IsEnum) {киньте новий ArgumentException ("T повинен бути переліченим типом"); }}
Том

172

Один вкладиш - Вільний синтаксис

public static class Extensions
{
    /// <summary>
    ///     A generic extension method that aids in reflecting 
    ///     and retrieving any attribute that is applied to an `Enum`.
    /// </summary>
    public static TAttribute GetAttribute<TAttribute>(this Enum enumValue) 
            where TAttribute : Attribute
    {
        return enumValue.GetType()
                        .GetMember(enumValue.ToString())
                        .First()
                        .GetCustomAttribute<TAttribute>();
    }
}

Приклад

public enum Season 
{
   [Display(Name = "It's autumn")]
   Autumn,

   [Display(Name = "It's winter")]
   Winter,

   [Display(Name = "It's spring")]
   Spring,

   [Display(Name = "It's summer")]
   Summer
}

public class Foo 
{
    public Season Season = Season.Summer;

    public void DisplayName()
    {
        var seasonDisplayName = Season.GetAttribute<DisplayAttribute>();
        Console.WriteLine("Which season is it?");
        Console.WriteLine (seasonDisplayName.Name);
    } 
}

Вихідні дані

Який сезон?
Це літо


2
Не існує визначення GetCustomAttribute
Тіто

3
@Tito переконайтеся, що ваш проект орієнтований .NET Framework 4.5і що ви включаєте наступні простори іменSystem.Net System.ComponentModel.DataAnnotations
Айдін

8
за допомогою System.Reflection; використання System.ComponentModel.DataAnnotations; Мені було потрібно.
Згрішив Лолут

1
яка жахлива конвенція про іменування!
цікавоБой

@curiousBoy Як GetAttribute<TAttribute>жахлива конвенція про іменування? Він отримує вказаний вами атрибут та використовує обкладинку Pascal, як і всі публічні методи.
Айдін

137

Спираючись на чудову відповідь Айдіна , ось метод розширення, який не вимагає параметрів типу.

using System;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;

public static class EnumExtensions
{
    public static string GetDisplayName(this Enum enumValue)
    {
        return enumValue.GetType()
                        .GetMember(enumValue.ToString())
                        .First()
                        .GetCustomAttribute<DisplayAttribute>()
                        .GetName();
    }
}

ПРИМІТКА: Замість властивості Name слід використовувати GetName (). Це забезпечує, що локалізований рядок буде повернуто, якщо використовувати властивість атрибута ResourceType.

Приклад

Щоб використовувати його, просто посилайтеся на значення enum у вашому представленні.

@{
    UserPromotion promo = UserPromotion.SendJobOffersByMail;
}

Promotion: @promo.GetDisplayName()

Вихідні дані

Акція: надсилайте пропозиції роботи поштою


4
Маємо додати такі простори імен: за допомогою системи; використання System.ComponentModel.DataAnnotations; за допомогою System.Linq; за допомогою System.Reflection;
Пітер Керр

Рішення Slick, але я отримую {"Шаблони можна використовувати лише з доступом до поля, доступом до власності, одновимірним індексом масиву або одновимірними спеціальними виразами індексатора."}
Casey Crookston,

Переглядаючи інші відповіді ТА на це повідомлення про помилку (я не знайомий з ним), виявляється, що ви можете використовувати це в рамках допоміжного методу Html (наприклад @Html.DisplayFor(m => m.myEnum.GetDisplayName()), який не буде працювати, оскільки вони очікують, що оцінений вираз дасть властивість або щось подібне. Ви повинні використовувати значення голого перерахунку, як у наведеному вище прикладі.
Todd

7
Я додав нульову контрольну перевірку до результату, GetCustomAttribute<DisplayAttribute>()оскільки для деяких Enums це можливо немає. Він повертається до того, enumValue.ToString()якщо не було присутності DisplayAttribute.
H Dog

1
Я використовував це, щоб створити List<SelectListItem>Enum, заповнений усіма окремими DisplayAttribute.Nameанотаціями - це спрацювало чудово, дякую !! public List<SelectListItem> MySelectListItem = new List<SelectListItem>(); foreach (MyEnum MyEnum in Enum.GetValues(typeof(MyEnum)).Cast<MyEnum>().Where(x => x != MyEnum.Default)) { MySelectListItem.Add(new SelectListItem() { Text = MyEnum.GetDisplayName(), Value = ((int)MyEnum).ToString() }); }
Хопер

61

На основі відповіді Айдіна я б запропонував менш "повторювану" реалізацію (тому що ми могли легко отримати значення Typeвід самого Enumзначення, а не надавати його як параметр 😉:

public static string GetDisplayName(this Enum enumValue)
{
    return enumValue.GetType().GetMember(enumValue.ToString())
                   .First()
                   .GetCustomAttribute<DisplayAttribute>()
                   .Name;
}

EDIT (на основі коментаря @Vahagn Nahapetyan)

public static string GetDisplayName(this Enum enumValue)
{
    return enumValue.GetType()?
                    .GetMember(enumValue.ToString())?
                    .First()?
                    .GetCustomAttribute<DisplayAttribute>()?
                    .Name;
}

Тепер ми можемо використовувати його дуже чисто таким чином:

public enum Season 
{
    [Display(Name = "The Autumn")]
    Autumn,

    [Display(Name = "The Weather")]
    Winter,

    [Display(Name = "The Tease")]
    Spring,

    [Display(Name = "The Dream")]
    Summer
}

Season.Summer.GetDisplayName();

Які результати в

"Мрія"


1
На сьогодні найпростіша і найпростіша з усіх відповідей. Дякую!
Кейсі Крукстон

Слід бути обережним із. First (). Це викине виняток, наприклад, якщо ваше ім'я перерахунку "Дорівнює"
Vahagn Nahapetyan

Я розумію "небезпеку" з First (). У цьому конкретному випадку це не здається проблемою. Тому що це метод розширення, де thisповинно бути дійсне (ненулеве) значення Enum. Інакше виклик методу вже кине (що є відповідальністю за код виклику). Це робить, що GetType(), безумовно, надасть правильний тип Enum, в якому enumvalueточно буде його членом. Але GetCustomAttribute може повернути нульове значення, тому я надав не виключну версію методу повернення null, коли ланцюжок викликів методу десь має нульове значення повернення. Дякую!
Бернуллі ІТ

1
Для другого варіанту вашого коду, схоже, немає необхідності використовувати нульовий умовний оператор після GetMember, оскільки цей метод завжди повертає масив MemberInfo і ніколи не повертає null. І мені здається, що краще використовувати FirstOrDefault замість просто First. Тоді використання нульового умовного оператора після FirstOrDefault буде вважатися послідовним.
Alex34758

28

Якщо ви використовуєте MVC 5.1 або вище, є більш простий і зрозумілий спосіб: просто використовуйте анотацію даних (з System.ComponentModel.DataAnnotationsпростору імен), як нижче:

public enum Color
{
    [Display(Name = "Dark red")]
    DarkRed,
    [Display(Name = "Very dark red")]
    VeryDarkRed,
    [Display(Name = "Red or just black?")]
    ReallyDarkRed
}

А з огляду, просто помістіть його у належний html-помічник:

@Html.EnumDropDownListFor(model => model.Color)

@SegmentationFault чому? Чи можете ви описати свою проблему? Яку версію .NET / MVC ви використовуєте? Яка помилка у вас? Будь ласка, будьте більш конкретними.
1_буг

6
Тому що він працює лише для Dropdowns, ніде більше.
Помилка сегментації

2
Здається, не існує ядра .net
Lonefish

3
.net core використовує Html.GetEnumSelectList (typeof (YourEnum)) @Lonefish
Патрік Маквай

2
якщо ми хочемо використовувати @ Html.DisplayFor (yourEnumField), ми можемо помістити Enum.cshtml в каталог DisplayTemplates (у спільному каталозі). у цей файл нам потрібно помістити всього 2 рядки. перше: "@model Enum", друге: "@GetDisplayName (Модель)." Метод GetDisplayName повинен бути таким, як у @Bernoulli IT answare
Розробник

11

Ви можете використовувати метод Type.GetMember , а потім отримати інформацію про атрибут за допомогою відображення:

// display attribute of "currentPromotion"

var type = typeof(UserPromotion);
var memberInfo = type.GetMember(currentPromotion.ToString());
var attributes = memberInfo[0].GetCustomAttributes(typeof(DisplayAttribute), false);
var description = ((DisplayAttribute)attributes[0]).Name;

Тут було кілька подібних дописів:

Отримання атрибутів значення Enum

Як змусити MVC3 DisplayFor показати значення відображуваного атрибута Enum?


8

Спираючись на чудову відповідь Тодда, яка базується на чудовій відповіді Айдіна , ось загальний метод розширення, який не вимагає параметрів типу.

/// <summary>
/// Gets human-readable version of enum.
/// </summary>
/// <returns>DisplayAttribute.Name property of given enum.</returns>
public static string GetDisplayName<T>(this T enumValue) where T : IComparable, IFormattable, IConvertible
{
    if (!typeof(T).IsEnum)
        throw new ArgumentException("Argument must be of type Enum");

    DisplayAttribute displayAttribute = enumValue.GetType()
                                                 .GetMember(enumValue.ToString())
                                                 .First()
                                                 .GetCustomAttribute<DisplayAttribute>();

    string displayName = displayAttribute?.GetName();

    return displayName ?? enumValue.ToString();
}

Мені це було потрібно для мого проекту, оскільки щось подібне до коду нижче, де не кожен член enum має DisplayAttribute, не працює з рішенням Тодда:

public class MyClass
{
    public enum MyEnum 
    {
        [Display(Name="ONE")]
        One,
        // No DisplayAttribute
        Two
    }
    public void UseMyEnum()
    {
        MyEnum foo = MyEnum.One;
        MyEnum bar = MyEnum.Two;
        Console.WriteLine(foo.GetDisplayName());
        Console.WriteLine(bar.GetDisplayName());
    }
}
// Output:
//
// ONE
// Two

Якщо це складне рішення простої проблеми, будь ласка, повідомте мене, але це було виправленням, яке я використав.


6
<ul>
    @foreach (int aPromotion in @Enum.GetValues(typeof(UserPromotion)))
    {
        var currentPromotion = (int)Model.JobSeeker.Promotion;
        if ((currentPromotion & aPromotion) == aPromotion)
        {
        <li>@Html.DisplayFor(e => currentPromotion)</li>
        }
    }
</ul>

Не працює: / Я отримую помилкуInvalidOperationException: Templates can be used only with field access, property access, single-dimension array index, or single-parameter custom indexer expressions.
Muflix

6

У мене є два рішення цього питання.

  1. Перше рішення полягає в отриманні відображуваних імен від enum.
public enum CourseLocationTypes
{
    [Display(Name = "On Campus")]
    OnCampus,
    [Display(Name = "Online")]
    Online,
    [Display(Name = "Both")]
    Both
}

public static string DisplayName(this Enum value)
{
    Type enumType = value.GetType();
    string enumValue = Enum.GetName(enumType, value);
    MemberInfo member = enumType.GetMember(enumValue)[0];

    object[] attrs = member.GetCustomAttributes(typeof(DisplayAttribute), false);
    string outString = ((DisplayAttribute)attrs[0]).Name;

    if (((DisplayAttribute)attrs[0]).ResourceType != null)
    {
        outString = ((DisplayAttribute)attrs[0]).GetName();
    }

    return outString;
}
<h3 class="product-title white">@Model.CourseLocationType.DisplayName()</h3>
  1. Друге рішення полягає в отриманні відображуваного імені від enum name, але це буде розбиття enum мовою розробника, що називається патчем.
public static string SplitOnCapitals(this string text)
{
        var r = new Regex(@"
            (?<=[A-Z])(?=[A-Z][a-z]) |
             (?<=[^A-Z])(?=[A-Z]) |
             (?<=[A-Za-z])(?=[^A-Za-z])", RegexOptions.IgnorePatternWhitespace);

        return r.Replace(text, " ");
}
 <div class="widget-box pt-0">
     @foreach (var item in Enum.GetNames(typeof(CourseLocationType)))
     {
         <label class="pr-2 pt-1">
             @Html.RadioButtonFor(x => x.CourseLocationType, item, new { type = "radio", @class = "iCheckBox control-label" })&nbsp; @item.SplitOnCapitals()
         </label>
     }
     @Html.ValidationMessageFor(x => x.CourseLocationType)
 </div>

5

Для ASP.Net Core 3.0 це працювало для мене (заслуга попередніх відповідей).

Мій клас Enum:

using System;
using System.Linq;
using System.ComponentModel.DataAnnotations;
using System.Reflection;

public class Enums
{
    public enum Duration
    { 
        [Display(Name = "1 Hour")]
        OneHour,
        [Display(Name = "1 Day")]
        OneDay
    }

    // Helper method to display the name of the enum values.
    public static string GetDisplayName(Enum value)
    {
        return value.GetType()?
       .GetMember(value.ToString())?.First()?
       .GetCustomAttribute<DisplayAttribute>()?
       .Name;
    }
}

Мій клас моделей перегляду:

public class MyViewModel
{
    public Duration Duration { get; set; }
}

Приклад перегляду бритви, що відображає етикетку та випадаючий список. Зауважте, що у випадаючому списку не потрібен допоміжний метод:

@model IEnumerable<MyViewModel> 

@foreach (var item in Model)
{
    <label asp-for="@item.Duration">@Enums.GetDisplayName(item.Duration)</label>
    <div class="form-group">
        <label asp-for="@item.Duration" class="control-label">Select Duration</label>
        <select asp-for="@item.Duration" class="form-control"
            asp-items="Html.GetEnumSelectList<Enums.Duration>()">
        </select>
    </div>
}

Я б додав чек на повернення рядка методу GetDisplayName.IsNullOrEmpty (retVal)? enumValue.ToString (): retVal;
Снайп

4

Щоб отримати доступ до цього атрибуту, потрібно використати трохи рефлексії:

var type = typeof(UserPromotion);
var member = type.GetMember(Model.JobSeeker.Promotion.ToString());
var attributes = member[0].GetCustomAttributes(typeof(DisplayAttribute), false);
var name = ((DisplayAttribute)attributes[0]).Name;

Я рекомендую перетворити цей метод в метод розширення або виконати його у переглядовій моделі.


4

З Core 2.1,

public static string GetDisplayName(Enum enumValue)
{
  return enumValue.GetType()?
 .GetMember(enumValue.ToString())?[0]?
 .GetCustomAttribute<DisplayAttribute>()?
 .Name;
}

4

поєднання всіх крайових корпусів разом зверху:

  • перерахувати членів з іменами членів базового об'єкта ( Equals,ToString )
  • необов’язковий Displayатрибут

ось мій код:

public enum Enum
{
    [Display(Name = "What a weird name!")]
    ToString,

    Equals
}

public static class EnumHelpers
{
    public static string GetDisplayName(this Enum enumValue)
    {
        var enumType = enumValue.GetType();

        return enumType
                .GetMember(enumValue.ToString())
                .Where(x => x.MemberType == MemberTypes.Field && ((FieldInfo)x).FieldType == enumType)
                .First()
                .GetCustomAttribute<DisplayAttribute>()?.Name ?? enumValue.ToString();
    }
}

void Main()
{
    Assert.Equals("What a weird name!", Enum.ToString.GetDisplayName());
    Assert.Equals("Equals", Enum.Equals.GetDisplayName());
}

Приємне рішення, яке обробляє необов'язковий атрибут Display. Дякую!
Wellspring

3

Вибачте за це, але я не зміг використати жодну з інших відповідей як є, і не встиг її оформити в коментарях.

Використовує синтаксис C # 6.

static class EnumExtensions
{
    /// returns the localized Name, if a [Display(Name="Localised Name")] attribute is applied to the enum member
    /// returns null if there isnt an attribute
    public static string DisplayNameOrEnumName(this Enum value)
    // => value.DisplayNameOrDefault() ?? value.ToString()
    {
        // More efficient form of ^ based on http://stackoverflow.com/a/17034624/11635
        var enumType = value.GetType();
        var enumMemberName = Enum.GetName(enumType, value);
        return enumType
            .GetEnumMemberAttribute<DisplayAttribute>(enumMemberName)
            ?.GetName() // Potentially localized
            ?? enumMemberName; // Or fall back to the enum name
    }

    /// returns the localized Name, if a [Display] attribute is applied to the enum member
    /// returns null if there is no attribute
    public static string DisplayNameOrDefault(this Enum value) =>
        value.GetEnumMemberAttribute<DisplayAttribute>()?.GetName();

    static TAttribute GetEnumMemberAttribute<TAttribute>(this Enum value) where TAttribute : Attribute =>
        value.GetType().GetEnumMemberAttribute<TAttribute>(value.ToString());

    static TAttribute GetEnumMemberAttribute<TAttribute>(this Type enumType, string enumMemberName) where TAttribute : Attribute =>
        enumType.GetMember(enumMemberName).Single().GetCustomAttribute<TAttribute>();
}

2

Спираючись далі на відповіді Айдіна і Тодда, ось метод розширення, який також дозволяє отримати ім'я з файлу ресурсу

using AppResources;
using System;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;
using System.Resources;

public static class EnumExtensions
{
    public static string GetDisplayName(this Enum enumValue)
    {
        var enumMember= enumValue.GetType()
                        .GetMember(enumValue.ToString());

        DisplayAttribute displayAttrib = null;
        if (enumMember.Any()) {
            displayAttrib = enumMember 
                        .First()
                        .GetCustomAttribute<DisplayAttribute>();
        }

        string name = null;
        Type resource = null;

        if (displayAttrib != null)
        {
            name = displayAttrib.Name;
            resource = displayAttrib.ResourceType;
        }

        return String.IsNullOrEmpty(name) ? enumValue.ToString()
            : resource == null ?  name
            : new ResourceManager(resource).GetString(name);
    }
}

і використовувати його як

public enum Season 
{
    [Display(ResourceType = typeof(Resource), Name = Season_Summer")]
    Summer
}

Я намагаюся змусити це працювати над своїм проектом, але я отримую помилку з "новим ResourceManager (ресурс) .GetString (ім'я);" рядок. Я задав запитання ( stackoverflow.com/questions/31319251/… ), і мене відправили сюди. Коли я переглядаю "ResourceManager (ресурс)" під час запуску, він повертає "Resources.Enums.resource". Будь-яка допомога буде дуже вдячна. Дякую!
Карінн

Оновлено код, щоб краще обробляти нулі, якщо у вас не встановлено відображувану назву для деяких значень перерахувань - це може допомогти
Пітер Керр

Це все ще не спрацювало. Я оновив своє запитання на stackoverflow.com/questions/31319251/… повідомленням про помилку. Дякую за допомогу!
Карінн

1

Я хочу зробити внесок у розширення переліку GetDisplayName, залежне від культури. Сподіваюсь, це буде корисним для всіх, хто гуглив цю відповідь, як я раніше:

"Стандартний" спосіб, як згадували Айдін Едн і Тодд :

    public static string GetDisplayName(this Enum enumValue)
    {
        return enumValue
            .GetType()
            .GetMember(enumValue.ToString())
            .First()
            .GetCustomAttribute<DisplayAttribute>()
            .GetName();
    }

"Культурно-залежний" спосіб:

    public static string GetDisplayName(this Enum enumValue, CultureInfo ci)
    {
        var displayAttr = enumValue
            .GetType()
            .GetMember(enumValue.ToString())
            .First()
            .GetCustomAttribute<DisplayAttribute>();

        var resMan = displayAttr.ResourceType?.GetProperty(@"ResourceManager", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic).GetValue(null, null) as ResourceManager;

        return resMan?.GetString(displayAttr.Name, ci) ?? displayAttr.GetName();
    }

1

Оновлення до 2020 року: оновлена ​​версія функції, що надається багатьма в цій темі, але тепер для C # 7.3:

Тепер ви можете обмежити загальні методи перерахуванням типів, щоб ви могли написати єдине розширення методу, щоб використовувати його з усіма перерахунками, як це:

Загальний метод розширення:

public static string ATexto<T>(this T enumeración) where T : struct, Enum {
    var tipo = enumeración.GetType();
    return tipo.GetMember(enumeración.ToString())
    .Where(x => x.MemberType == MemberTypes.Field && ((FieldInfo)x).FieldType == tipo).First()
    .GetCustomAttribute<DisplayAttribute>()?.Name ?? enumeración.ToString();
} 

Перерахунок:

public enum TipoImpuesto { 
IVA, INC, [Display(Name = "IVA e INC")]IVAeINC, [Display(Name = "No aplica")]NoAplica };

Як ним користуватися:

var tipoImpuesto = TipoImpuesto.IVAeINC;
var textoTipoImpuesto = tipoImpuesto.ATexto(); // Prints "IVA e INC".

Бонус, перерахунки з прапорами: Якщо ви маєте справу з нормальними переліками, функція вище є достатньою, але якщо хтось із ваших переліків може приймати кілька значень за допомогою прапорів, то вам потрібно буде змінити його так (Цей код використовує C # 8 особливості):

    public static string ATexto<T>(this T enumeración) where T : struct, Enum {

        var tipo = enumeración.GetType();
        var textoDirecto = enumeración.ToString();

        string obtenerTexto(string textoDirecto) => tipo.GetMember(textoDirecto)
            .Where(x => x.MemberType == MemberTypes.Field && ((FieldInfo)x).FieldType == tipo)
            .First().GetCustomAttribute<DisplayAttribute>()?.Name ?? textoDirecto;

        if (textoDirecto.Contains(", ")) {

            var texto = new StringBuilder();
            foreach (var textoDirectoAux in textoDirecto.Split(", ")) {
                texto.Append($"{obtenerTexto(textoDirectoAux)}, ");
            }
            return texto.ToString()[0..^2];

        } else {
            return obtenerTexto(textoDirecto);
        }

    } 

Перерахунок із прапорами:

[Flags] public enum TipoContribuyente {
    [Display(Name = "Común")] Común = 1, 
    [Display(Name = "Gran Contribuyente")] GranContribuyente = 2, 
    Autorretenedor = 4, 
    [Display(Name = "Retenedor de IVA")] RetenedorIVA = 8, 
    [Display(Name = "Régimen Simple")] RégimenSimple = 16 } 

Як ним користуватися:

var tipoContribuyente = TipoContribuyente.RetenedorIVA | TipoContribuyente.GranContribuyente;
var textoAux = tipoContribuyente.ATexto(); // Prints "Gran Contribuyente, Retenedor de IVA".

0

На основі попередніх відповідей я створив цей зручний помічник для підтримки всіх властивостей DisplayAttribute в читаному вигляді:

public static class EnumExtensions
    {
        public static DisplayAttributeValues GetDisplayAttributeValues(this Enum enumValue)
        {
            var displayAttribute = enumValue.GetType().GetMember(enumValue.ToString()).First().GetCustomAttribute<DisplayAttribute>();

            return new DisplayAttributeValues(enumValue, displayAttribute);
        }

        public sealed class DisplayAttributeValues
        {
            private readonly Enum enumValue;
            private readonly DisplayAttribute displayAttribute;

            public DisplayAttributeValues(Enum enumValue, DisplayAttribute displayAttribute)
            {
                this.enumValue = enumValue;
                this.displayAttribute = displayAttribute;
            }

            public bool? AutoGenerateField => this.displayAttribute?.GetAutoGenerateField();
            public bool? AutoGenerateFilter => this.displayAttribute?.GetAutoGenerateFilter();
            public int? Order => this.displayAttribute?.GetOrder();
            public string Description => this.displayAttribute != null ? this.displayAttribute.GetDescription() : string.Empty;
            public string GroupName => this.displayAttribute != null ? this.displayAttribute.GetGroupName() : string.Empty;
            public string Name => this.displayAttribute != null ? this.displayAttribute.GetName() : this.enumValue.ToString();
            public string Prompt => this.displayAttribute != null ? this.displayAttribute.GetPrompt() : string.Empty;
            public string ShortName => this.displayAttribute != null ? this.displayAttribute.GetShortName() : this.enumValue.ToString();
        }
    }

0

Я намагався робити це як редагування, але це було відхилено; Я не можу зрозуміти, чому.

Вищенаведене буде винятком, якщо ви називатимете його Enum, який містить поєднання спеціальних атрибутів та простих елементів, наприклад

public enum CommentType
{
    All = 1,
    Rent = 2,
    Insurance = 3,
    [Display(Name="Service Charge")]
    ServiceCharge = 4
}

Тож я так незначно змінив код, щоб перевірити наявність спеціальних атрибутів, перш ніж намагатися отримати доступ до них, і використати ім'я, якщо жодного не знайдено.

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;

public static class EnumHelper<T>
{
    public static IList<T> GetValues(Enum value)
    {
        var enumValues = new List<T>();

        foreach (FieldInfo fi in value.GetType().GetFields(BindingFlags.Static | BindingFlags.Public))
        {
            enumValues.Add((T)Enum.Parse(value.GetType(), fi.Name, false));
        }
        return enumValues;
    }

    public static T Parse(string value)
    {
        return (T)Enum.Parse(typeof(T), value, true);
    }

    public static IList<string> GetNames(Enum value)
    {
        return value.GetType().GetFields(BindingFlags.Static | BindingFlags.Public).Select(fi => fi.Name).ToList();
    }

    public static IList<string> GetDisplayValues(Enum value)
    {
        return GetNames(value).Select(obj => GetDisplayValue(Parse(obj))).ToList();
    }

    private static string lookupResource(Type resourceManagerProvider, string resourceKey)
    {
        foreach (PropertyInfo staticProperty in resourceManagerProvider.GetProperties(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public))
        {
            if (staticProperty.PropertyType == typeof(System.Resources.ResourceManager))
            {
                System.Resources.ResourceManager resourceManager = (System.Resources.ResourceManager)staticProperty.GetValue(null, null);
                return resourceManager.GetString(resourceKey);
            }
        }

        return resourceKey; // Fallback with the key name
    }

    public static string GetDisplayValue(T value)
    {
        var fieldInfo = value.GetType().GetField(value.ToString());

        var descriptionAttributes = fieldInfo.GetCustomAttributes(
            typeof(DisplayAttribute), false) as DisplayAttribute[];

        if (descriptionAttributes.Any() && descriptionAttributes[0].ResourceType != null)
            return lookupResource(descriptionAttributes[0].ResourceType, descriptionAttributes[0].Name);

        if (descriptionAttributes == null) return string.Empty;
        return (descriptionAttributes.Length > 0) ? descriptionAttributes[0].Name : value.ToString();
    }
}

0

За допомогою MVC5 ви можете використовувати:

public enum UserPromotion
{
   None = 0x0,

   [Display(Name = "Send Job Offers By Mail")]
   SendJobOffersByMail = 0x1,

   [Display(Name = "Send Job Offers By Sms")]
   SendJobOffersBySms = 0x2,

   [Display(Name = "Send Other Stuff By Sms")]
   SendPromotionalBySms = 0x4,

   [Display(Name = "Send Other Stuff By Mail")]
   SendPromotionalByMail = 0x8
}

тоді, якщо ви хочете створити селектор, що випадає, ви можете використовувати:

@Html.EnumDropdownListFor(expression: model => model.PromotionSelector, optionLabel: "Select") 
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.