Search code examples
c#razorenumsasp.net-mvc-5.1

MVC 5.1 Razor DisplayFor not working with Enum DisplayName


I have the following entity (domain) object and model that contain an enum. The display name appears correctly and works for a EnumDropdownList but for some reason not for the DisplayFor helper, all that is shown is the actual enum name.

Not sure what I am missing, asp.net MVC 5.1 added display name support for this so I shouldn't need to create my own helper methods. See: https://aspnet.codeplex.com/SourceControl/latest#Samples/MVC/EnumSample/EnumSample/Models/Enums.cs

public class Addon
{
    public int Id { get; set; }
    public AddonType AddonType { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public bool IsActive { get; set; }
}

public enum AddonType : byte
{
    [Display(Name = "Cake Theme")]
    CakeTheme,
    [Display(Name = "Cake Flavour")]
    CakeFlavour,
    [Display(Name = "Cupcake Icing")]
    CupcakeIcing,
    [Display(Name = "Party Addon")]
    AddOn
}

MODEL

public class AddonModel
{
    public int Id { get; set; }
    public AddonType AddonType { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public int Quantity { get; set; }
    public bool IsActive { get; set; }
}

VIEW

<h2>Index</h2>

<p>
    @Html.ActionLink("Create New", "Create")
</p>
<table class="table">
    <tr>
        <th>Type</th>
        <th>Name</th>
        <th></th>
    </tr>

@foreach (var item in Model) {
    <tr>
        <td>
            @Html.DisplayFor(model => item.AddonType)
        </td>
        <td>
            @Html.DisplayFor(model => item.Name)
        </td>
        <td>
            @Html.DisplayFor(model => item.Price)
        </td>
        <td>
            @Html.ActionLink("Edit", "Edit", new { id=item.Id }) |
            @Html.ActionLink("Details", "Details", new { id=item.Id }) |
            @Html.ActionLink("Delete", "Delete", new { id=item.Id })
        </td>
    </tr>
}

</table>

Solution

  • Create new folder Views/Shared/DisplayTemplates
    Add empty Partial View named Enum, to the folder
    Replace Enum View code with:

    @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)
    }
    

    Here is the link to detailed article by Shahriar Hossain