创建视图中可用的自定义帮助程序

时间:2012-02-05 10:57:14

标签: c# asp.net-mvc asp.net-mvc-3 razor view-helpers

我有太多的文字实用工具方法,例如MakeShortText(string text, int length)RemoveTags(string text)TimeAgo(DateTime date)等。 我想从单独的帮助程序访问它们,如下例所示:

@Text().MakeShortText(Model.Text, 10)

是否可以创建此类扩展?或者我必须像这样对HtmlHelper进行扩展:

@Html.Text().MaksShortText(Model.Text, 10)

1 个答案:

答案 0 :(得分:11)

您可以先定义自定义TextHelper

public class TextHelper
{
    public TextHelper(ViewContext viewContext)
    {
        ViewContext = viewContext;
    }

    public ViewContext ViewContext { get; private set; }
}

然后让您的所有方法成为此TextHelper的扩展方法:

public static class TextHelperExtensions
{
    public static IHtmlString MakeShortText(
        this TextHelper textHelper, 
        string text,
        int value
    )
    {
        ...
    }
}

然后您可以定义自定义网页:

public abstract class MyWebViewPage<T> : WebViewPage<T>
{
    public override void InitHelpers()
    {
        base.InitHelpers();
        Text = new TextHelper(ViewContext);
    }

    public TextHelper Text { get; private set; }
}

然后在~/Views/web.config~/web.config中的 >)中使用pageBaseType属性将此自定义网页配置为Razor视图的基页:

<pages pageBaseType="AppName.Web.Mvc.MyWebViewPage">
    <namespaces>
        <add namespace="System.Web.Mvc" />
        <add namespace="System.Web.Mvc.Ajax" />
        <add namespace="System.Web.Mvc.Html" />
        <add namespace="System.Web.Routing" />
    </namespaces>
</pages>

然后在您的观看中,您将能够使用:

@Text.MakeShortText(Model.Text, 10)

如果您想使用问题中显示的以下语法:

@Text().MakeShortText(Model.Text, 10)

只需修改自定义视图引擎,以便Text不是属性,而是返回TextHelper实例的方法。或者甚至返回HtmlHelper个实例,这样您就不需要将现有的扩展方法移至TextHelper

public abstract class MyWebViewPage<T> : WebViewPage<T>
{
    public HtmlHelper Text()
    {
        return Html;
    }
}

第二种语法也是可能的:

@Html.Text().MaksShortText(Model.Text, 10)

只需为Text()类定义自定义HtmlHelper扩展名:

public static class HtmlExtensions
{
    public static TextHelper Text(this HtmlHelper htmlHelper)
    {
        return new TextHelper(htmlHelper.ViewContext);
    }
}

然后以与第一种情况相同的方式将自定义方法作为此TextHelper类的扩展方法。