O que é um MvcHtmlString e quando devo usá-lo?

A documentação para MvcHtmlStringnão é terrivelmente esclarecedora:

Representa uma seqüência de caracteres codificada em HTML que não deve ser codificada novamente.

Não está claro para mim quais são exatamente as implicações disso. Parece que alguns métodos auxiliares de HTML retornam um MvcHtmlString, mas vários exemplos que eu vi on-line de auxiliares personalizados retornam uma sequência regular.

Questões:

O que é um MvcHtmlString?

Quando devo escolher MvcHtmlStringmais stringe vice-versa? Por quê?

O ASP.NET 4 apresenta uma nova sintaxe de nugget de código <%: %>. Essencialmente, <%: foo %>traduz para <%= HttpUtility.HtmlEncode(foo) %>. A equipe está tentando fazer com que os desenvolvedores usem, em <%: %>vez de, <%= %>sempre que possível, impedir o XSS.

No entanto, isso introduz o problema de que, se um nugget de código já codificar seu resultado, a <%: %>sintaxe o codificará novamente . Isso é resolvido com a introdução da interface IHtmlString (nova no .NET 4). Se o foo () em <%: foo() %>retornos uma IHtmlString, a <%: %>sintaxe não vai voltar a codificar ele.

Os ajudantes do MVC 2 retornam MvcHtmlString, que no ASP.NET 4 implementa a interface IHtmlString. Portanto, quando os desenvolvedores usam <%: Html.*() %>no ASP.NET 4, o resultado não será codificado duas vezes.

Editar:

Um benefício imediato dessa nova sintaxe é que suas visualizações são um pouco mais limpas. Por exemplo, você pode escrever em <%: ViewData["anything"] %>vez de <%= Html.Encode(ViewData["anything"]) %>.

Esta é uma resposta tardia, mas se alguém que está lendo esta pergunta estiver usando o razor, o que você deve lembrar é que o razor codifica tudo por padrão, mas, usando MvcHtmlStringseus auxiliares html, você pode dizer ao razor que ele não precisa codificá-lo .

Se você deseja que o barbeador não codifique uma string, use

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

Descompilar Raw (), mostra que está quebrando a string em um HtmlString

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

"O HtmlString existe apenas no ASP.NET 4.

MvcHtmlString foi um calço de compatibilidade adicionado ao MVC 2 para oferecer suporte ao .NET 3.5 e .NET 4. Agora que o MVC 3 é apenas o .NET 4, é uma subclasse bastante trivial do HtmlString, presumivelmente para o MVC 2-> 3, para compatibilidade de origem. " fonte

Um bom uso prático disso é se você deseja criar suas próprias HtmlHelperextensões. Por exemplo, eu odeio tentar lembrar a <link>sintaxe da tag, então criei meu próprio método de extensão para criar uma <link>tag:

<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

Eu poderia ter retornado Stringdeste método, mas se eu tivesse o seguinte quebraria:

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

Com MvcHtmlString, usar um <%: ... %>ou <%= ... %>ambos funcionará corretamente.

Você usaria um MvcHtmlStringse quiser passar o HTML bruto para um método auxiliar do MVC e não desejar que o método auxiliar codifique o HTML.