正在创建自定义Html帮助程序:MyHelperFor

本文关键字：帮助程序 MyHelperFor Html 自定义 创建 | 更新日期: 2023-09-27 18:29:08

我想创建一个可以像一样使用的助手

@Html.MyHelperFor(m => m.Name)

例如

<span name="Name" data-something="Name"></span>

如果是@Html.MyHelperFor(m => m.MailID)这应该会返回

<span name="MailID" data-something="MailID"></span>

我认为，我应该能够访问helper方法中的Property名称来生成这种类型的helper。

我该怎么做？

正在创建自定义Html帮助程序:MyHelperFor

您可以执行类似的操作（以下内容也将采用额外的HTML属性）。

public static MvcHtmlString MyHelperFor<TModel, TValue>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TValue>> expression, object htmlAttributes = null)
{
    var data = ModelMetadata.FromLambdaExpression(expression, helper.ViewData);
    string propertyName = data.PropertyName;
    TagBuilder span = new TagBuilder("span");
    span.Attributes.Add("name", propertyName);
    span.Attributes.Add("data-something", "something");
    if (htmlAttributes != null)
    {
        var attributes = HtmlHelper.AnonymousObjectToHtmlAttributes(htmlAttributes);
        span.MergeAttributes(attributes);
    }
    return new MvcHtmlString(span.ToString());
}

您可以使用ModelMetadata中的FromLambaExpression方法，如下所示：

namespace System.Web.Mvc.Html
{
    public static class CustomHelpers
    {
        public static MvcHtmlString MyHelperFor<TModel, TValue>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TValue>> expression)
        {
            var metaData = ModelMetadata.FromLambdaExpression(expression, helper.ViewData);
            var name = metaData.PropertyName;
            // create your html string, you could defer to DisplayFor to render a span or
            // use the TagBuilder class to create a span and add your attributes to it
            string html = "";
            return new MvcHtmlString(html);
        }
    }
}

ModelMetadata类位于System.Web.Mvc命名空间中。FromLambdaExpression方法是内置助手使用的方法，因此您可以确保您的助手将与内置助手起相同的作用。通过将CustomHelpers类放置在System.Web.Mvc.Html命名空间中，您就可以像访问其他助手（即@Html.MyHelperFor()）一样访问您的助手。

这应该会让您开始。这个函数直接返回属性名称，但您应该能够通过一些工作将其转换为您正在寻找的扩展。此示例具有正确的方法签名和对ExpressionHelper的调用，以获取属性的名称。

    public static MvcHtmlString MyHelperFor<TModel, TValue>(this HtmlHelper<TModel> htmlHelper, Expression<Func<TModel, TValue>> expression)
    {
        string expressionName = ExpressionHelper.GetExpressionText(expression);
        return new MvcHtmlString(expressionName);
    }

根据mattytomo的回答，这很有效，但在与复杂对象一起使用时只有一个小问题，例如，如果您正在将此代码用于EditorTemplate内的属性。

代替

var data = ModelMetadata.FromLambdaExpression(expression, helper.ViewData);
string propertyName = data.PropertyName;

如果使用MVC4，您可以将其更改为

var propertyName = helper.NameFor(expression);

或MVC3和以下

var propertyName = expression.Body.ToString();
propertyName = propertyName.Substring(propertyName.IndexOf(".") + 1);
if (!string.IsNullOrEmpty(helper.ViewData.TemplateInfo.HtmlFieldPrefix))
    propertyName = string.Format("{0}.{1}", helper.ViewData.TemplateInfo.HtmlFieldPrefix, propertyName);

完整代码：

    public static MvcHtmlString MyHelperFor<TModel, TValue>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TValue>> expression, object htmlAttributes = null)
    {
        var propertyName = expression.Body.ToString();
        propertyName = propertyName.Substring(propertyName.IndexOf(".") + 1);
        if (!string.IsNullOrEmpty(helper.ViewData.TemplateInfo.HtmlFieldPrefix))
            propertyName = string.Format("{0}.{1}", helper.ViewData.TemplateInfo.HtmlFieldPrefix, propertyName);
        TagBuilder span = new TagBuilder("span");
        span.Attributes.Add("name", propertyName);
        span.Attributes.Add("data-something", propertyName);
        if (htmlAttributes != null)
        {
            var attributes = HtmlHelper.AnonymousObjectToHtmlAttributes(htmlAttributes);
            span.MergeAttributes(attributes);
        }
        return new MvcHtmlString(span.ToString());
    }
相关文章：