Qu'est-ce qu'un MvcHtmlString et quand dois-je l'utiliser?

La documentation de MvcHtmlStringn'est pas très éclairante:

Représente une chaîne codée en HTML qui ne doit plus être codée.

Je ne sais pas exactement quelles sont les implications de cela. Il semble que certaines méthodes d'assistance HTML renvoient un MvcHtmlString, mais plusieurs exemples que j'ai vus en ligne d'assistants personnalisés renvoient simplement une chaîne régulière.

Des questions:

Qu'est-ce qu'un MvcHtmlString?

Quand dois - je choisir MvcHtmlStringplus stringet vice - versa? Pourquoi?

ASP.NET 4 introduit une nouvelle syntaxe de nugget de code <%: %>. Essentiellement, se <%: foo %>traduit par <%= HttpUtility.HtmlEncode(foo) %>. L'équipe essaie de faire en sorte que les développeurs utilisent <%: %>plutôt <%= %>que possible pour empêcher XSS.

Cependant, cela pose le problème que si un nugget de code code déjà son résultat, la <%: %>syntaxe le ré-encodera . Cela est résolu par l'introduction de l'interface IHtmlString (nouveau dans .NET 4). Si foo () dans <%: foo() %>renvoie un IHtmlString, la <%: %>syntaxe ne le réencodera pas.

Les assistants de MVC 2 renvoient MvcHtmlString, qui sur ASP.NET 4 implémente l'interface IHtmlString. Par conséquent, lorsque les développeurs utilisent <%: Html.*() %>dans ASP.NET 4, le résultat ne sera pas codé en double.

Éditer:

Un avantage immédiat de cette nouvelle syntaxe est que vos vues sont un peu plus propres. Par exemple, vous pouvez écrire à la <%: ViewData["anything"] %>place de <%= Html.Encode(ViewData["anything"]) %>.

C'est une réponse tardive, mais si quelqu'un qui lit cette question utilise un rasoir, vous devez vous rappeler que le rasoir code tout par défaut, mais en utilisant MvcHtmlStringdans vos assistants html vous pouvez dire à rasoir qu'il n'a pas besoin de le coder .

Si vous voulez que le rasoir ne code pas une chaîne, utilisez

@Html.Raw("<span>hi</span>")

La décompilation de Raw (), nous montre qu'elle enveloppe la chaîne dans un HtmlString

public IHtmlString Raw(string value) {
    return new HtmlString(value); 
}

" HtmlString n'existe que dans ASP.NET 4.

MvcHtmlString était une cale de compatibilité ajoutée à MVC 2 pour prendre en charge à la fois .NET 3.5 et .NET 4. Maintenant que MVC 3 est .NET 4 uniquement, il s'agit d'une sous-classe assez banale de HtmlString vraisemblablement pour MVC 2-> 3 pour la compatibilité avec la source. " source

Une bonne utilisation pratique de ceci est si vous voulez créer vos propres HtmlHelperextensions. Par exemple, je déteste essayer de me souvenir de la <link>syntaxe des balises, j'ai donc créé ma propre méthode d'extension pour créer une <link>balise:

<Extension()> _
Public Function CssBlock(ByVal html As HtmlHelper, ByVal src As String, ByVal Optional ByVal htmlAttributes As Object = Nothing) As MvcHtmlString
    Dim tag = New TagBuilder("link")
    tag.MergeAttribute("type", "text/css")
    tag.MergeAttribute("rel", "stylesheet")
    tag.MergeAttribute("href", src)
    tag.MergeAttributes(New RouteValueDictionary(htmlAttributes))
    Dim result = tag.ToString(TagRenderMode.Normal)
    Return MvcHtmlString.Create(result)
End Function

J'aurais pu revenir Stringde cette méthode, mais si j'avais eu ce qui suit se briserait:

<%: Html.CssBlock(Url.Content("~/sytles/mysite.css")) %>

Avec MvcHtmlString, l'utilisation de l'un <%: ... %>ou de l' autre <%= ... %>fonctionnera correctement.

Vous utiliseriez un MvcHtmlStringsi vous voulez passer du HTML brut à une méthode d'assistance MVC et que vous ne voulez pas que la méthode d'assistance code le HTML.