web-dev-qa-db-ja.com

MVC.netは、ビューで列挙型を参照する必要なく、ビューで列挙表示名を取得します

ViewModelBaseクラスに次のヘルパーメソッドがあり、他のビューモデルによって継承されています。

public string GetEnumName<T>(Enum value)
        {
            Type enumType = typeof(T);
            var enumValue = Enum.GetName(enumType, value);
            MemberInfo member = enumType.GetMember(enumValue)[0];

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

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

            return outString;
        }

次に、これを次のようなビューから呼び出します。

<p>
@{var rel = Model.GetEnumDisplayName<Enums.wheteverEnum>(Model.wheteverEnum); }
@rel
</p>

質問です-このメソッドを使用できるので、enumのタイプを通知する必要はありませんか?基本的に、すべてのenumsについてこれを実行します。

@ Model.GetEnumDisplayName(Model.wheteverEnum)

typeofなし、Tなし、ビューでEnums名前空間への参照を追加する必要なし...

可能?

25
nathfy

Typeパラメータを削除して、それを拡張メソッドにすることができます。

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

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

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

        return outString;
    }

    @Model.wheteverEnum.DisplayName()
54
jrummell

これを拡張メソッドとして記述できませんか?何かのようなもの...

public static class EnumExtensions
{
  public static string ToDescription(this Enum e)
  {
     var attributes = (DisplayAttribute[])e.GetType().GetField(e.ToString()).GetCustomAttributes(typeof(DisplayAttribute), false);
     return attributes.Length > 0 ? attributes[0].Description : string.Empty;
  }
}

使用法:

@Model.WhateverEnum.ToDescription();
7
devdigital

@jrummellさん、ありがとうございます!

以下の小さなTweakを追加しました。これは、列挙型に関連付けられたDisplay属性がないシナリオをキャプチャします(現在は例外をスローします)。

/// <summary>
/// Gets the DataAnnotation DisplayName attribute for a given enum (for displaying enums values nicely to users)
/// </summary>
/// <param name="value">Enum value to get display for</param>
/// <returns>Pretty version of enum (if there is one)</returns>
/// <remarks>
/// Inspired by :
///     http://stackoverflow.com/questions/9328972/mvc-net-get-enum-display-name-in-view-without-having-to-refer-to-enum-type-in-vi
/// </remarks>
public static string DisplayFor(this Enum value) {
    Type enumType = value.GetType();
    var enumValue = Enum.GetName(enumType, value);
    MemberInfo member = enumType.GetMember(enumValue)[0];
    string outString = "";

    var attrs = member.GetCustomAttributes(typeof(DisplayAttribute), false);
    if (attrs.Any()) {
        var displayAttr = ((DisplayAttribute)attrs[0]);

        outString = displayAttr.Name;

        if (displayAttr.ResourceType != null) {
            outString = displayAttr.GetName();
        }
    } else {
        outString = value.ToString();
    }

    return outString;
}
5
toepoke.co.uk

VB.NETでの@jrummellの答えは、数人の私たちにとって...

Module ModuleExtension

    <Extension()>
    Public Function DisplayName(ByVal value As System.Enum) As String

        Dim enumType As Type = value.GetType()
        Dim enumValue = System.Enum.GetName(enumType, value)
        Dim member As MemberInfo = enumType.GetMember(enumValue)(0)

        Dim attrs = member.GetCustomAttributes(GetType(DisplayAttribute), False)
        Dim outString = CType(attrs(0), DisplayAttribute).Name

        If (CType(attrs(0), DisplayAttribute).ResourceType IsNot Nothing) Then
            outString = CType(attrs(0), DisplayAttribute).GetName()
        End If

        Return outString
    End Function


End Module
1
Pierre Watelet

この質問に到達する可能性のある人にとって、これは他の何よりもはるかに簡単であることがわかりました: https://www.codeproject.com/articles/776908/dealing-with-enum-in-mvc

「Views\Shared」の下に「DisplayTemplate」というフォルダを作成し、新しいフォルダ「DisplayTemplate」に空のビュー(「Enum」という名前を付けます)を作成し、このコードをそれにコピーします」

@model Enum

@if (EnumHelper.IsValidForEnumHelper(ViewData.ModelMetadata))
{
    // Display Enum using same names (from [Display] attributes) as in editors
    string displayName = null;
    foreach (SelectListItem item in EnumHelper.GetSelectList(ViewData.ModelMetadata, (Enum)Model))
    {
        if (item.Selected)
        {
            displayName = item.Text ?? item.Value;
        }
    }

    // Handle the unexpected case that nothing is selected
    if (String.IsNullOrEmpty(displayName))
    {
        if (Model == null)
        {
            displayName = String.Empty;
        }
        else
        {
            displayName = Model.ToString();
        }
    }

    @Html.DisplayTextFor(model => displayName)
}
else
{
    // This Enum type is not supported.  Fall back to the text.
    @Html.DisplayTextFor(model => model)
}
1

これが私がこれだけを行うために作成した拡張メソッドです... Enum名を解析して大文字で分割するためのロジックが少し追加されています。表示属性を使用して任意の名前を上書きできます

public static TAttribute GetAttribute<TAttribute>(this ICustomAttributeProvider parameterInfo) where TAttribute : Attribute
{
    object[] attributes = parameterInfo.GetCustomAttributes(typeof(TAttribute), false);
    return attributes.Length > 0 ? (TAttribute)attributes[0] : null;
}
public static bool HasAttribute<TAttribute>(this ICustomAttributeProvider parameterInfo) where TAttribute : Attribute
{
    object[] attributes = parameterInfo.GetCustomAttributes(typeof(TAttribute), false);
    return attributes.Length > 0 ? true : false;
}

public static string ToFriendlyEnum(this Enum type)
{
    return type.GetType().HasAttribute<DescriptionAttribute>() ? type.GetType().GetAttribute<DescriptionAttribute>().Description : type.ToString().ToFriendlyEnum();
}

public static string ToFriendlyEnum(this string value)
{
    char[] chars = value.ToCharArray();
    string output = string.Empty;

    for (int i = 0; i < chars.Length; i++)
    {
        if (i <= 0 || chars[i - 1].ToString() != chars[i - 1].ToString().ToUpper() && chars[i].ToString() != chars[i].ToString().ToLower())
        {
            output += " ";
        }

        output += chars[i];
    }

    return output.Trim();
}

GetAttribute拡張メソッドは少しやり過ぎになる可能性がありますが、私はプロジェクトの他の場所でそれらを使用しているため、Enum拡張を記述したときに再利用されました。それらをToFriendlyEnum(このEnumタイプ)メソッドに簡単に戻すことができます。

0
Anthony Shaw

提案された解決策は、MVC3で私のために機能しません:なので、以下のヘルパーは良いです:

    public static string GetEnumDescription(this Enum value)
    {
        Type type = value.GetType();
        string name = Enum.GetName(type, value);
        if (name != null)
        {
            FieldInfo field = type.GetField(name);
            if (field != null)
            {
                string attr = field.GetCustomAttributesData()[0].NamedArguments[0].TypedValue.Value.ToString();
                if (attr == null)
                {
                    return name;
                }
                else
                {
                    return attr;
                }
            }
        }
        return null;
    }
0
Anis Saddoud