从HTML帮助程序中提取显示名称和描述属性

时间:2011-02-11 20:42:13

标签: c# reflection asp.net-mvc-2 attributes html-helper

我正在构建一个如下所示的自定义HTML.LabelFor帮助程序:

public static MvcHtmlString LabelFor<TModel, TValue>(this HtmlHelper<TModel> self, Expression<Func<TModel, TValue>> expression, Boolean showToolTip)
{
  var metadata = ModelMetadata.FromLambdaExpression(expression, self.ViewData);
  ...
}

为了能够获得属性的正确名称,我使用以下代码:

metadata.DisplayName

在我得到的ModelView类的属性上:

[DisplayName("Titel")]

问题在于我还需要描述。有一个名为Display的属性,它有名称和描述,但是我没有看到如何使用上面代码中的元数据变量来提取它?

1 个答案:

答案 0 :(得分:19)

免责声明:以下内容仅适用于ASP.NET MVC 3(如果您使用以前的版本,请参阅底部的更新)

假设以下型号:

public class MyViewModel
{
    [Display(Description = "some description", Name = "some name")]
    public string SomeProperty { get; set; }
}

以下观点:

<%= Html.LabelFor(x => x.SomeProperty, true) %>

在自定义助手中,您可以从元数据中获取此信息:

public static MvcHtmlString LabelFor<TModel, TValue>(
    this HtmlHelper<TModel> self, 
    Expression<Func<TModel, TValue>> expression, 
    bool showToolTip
)
{
    var metadata = ModelMetadata.FromLambdaExpression(expression, self.ViewData);
    var description = metadata.Description; // will equal "some description"
    var name = metadata.DisplayName; // will equal "some name"
    // TODO: do something with the name and the description
    ...
}

备注:同一模型属性上的[DisplayName("foo")][Display(Name = "bar")]是多余的,[Display]属性中使用的名称优先于metadata.DisplayName


更新:

我之前的回答不适用于ASP.NET MVC 2.0。默认情况下,有一些属性无法在.NET 3.5中填充DataAnnotationsDescription就是其中之一。要在ASP.NET MVC 2.0中实现此目的,您可以使用自定义模型元数据提供程序:

public class DisplayMetaDataProvider : DataAnnotationsModelMetadataProvider
{
    protected override ModelMetadata CreateMetadata(
        IEnumerable<Attribute> attributes, 
        Type containerType,
        Func<object> modelAccessor, 
        Type modelType, 
        string propertyName
    )
    {
        var metadata = base.CreateMetadata(attributes, containerType, modelAccessor, modelType, propertyName);

        var displayAttribute = attributes.OfType<DisplayAttribute>().FirstOrDefault();
        if (displayAttribute != null)
        {
            metadata.Description = displayAttribute.Description;
            metadata.DisplayName = displayAttribute.Name;
        }
        return metadata;
    }
}

您将在Application_Start注册:

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    RegisterRoutes(RouteTable.Routes);
    ModelMetadataProviders.Current = new DisplayMetaDataProvider();
}

然后帮助程序应该按预期工作:

public static MvcHtmlString LabelFor<TModel, TValue>(
    this HtmlHelper<TModel> self, 
    Expression<Func<TModel, TValue>> expression, 
    bool showToolTip
)
{
    var metadata = ModelMetadata.FromLambdaExpression(expression, self.ViewData);
    var description = metadata.Description; // will equal "some description"
    var name = metadata.DisplayName; // will equal "some name"
    // TODO: do something with the name and the description
    ...
}