HttpServerUtility.HtmlEncode Método

Definição

Namespace:

System.Web

Assembly:

System.Web.dll

Codifica uma cadeia de caracteres a ser exibida em um navegador.

Para codificar ou decodificar valores fora de um aplicativo Web, use a classe WebUtility.

Sobrecargas

HtmlEncode(String)	Codifica uma cadeia de caracteres em HTML e retorna a cadeia de caracteres codificada.
HtmlEncode(String, TextWriter)	Codifica uma cadeia de caracteres em HTML e envia a saída resultante para um fluxo de saída TextWriter.

HtmlEncode(String)

Codifica uma cadeia de caracteres em HTML e retorna a cadeia de caracteres codificada.

public:
 System::String ^ HtmlEncode(System::String ^ s);

public string HtmlEncode (string s);

member this.HtmlEncode : string -> string

Public Function HtmlEncode (s As String) As String

Parâmetros

s

String

A cadeia de texto a ser codificada.

Retornos

String

O texto codificado em HTML.

Exemplos

O exemplo a seguir mostra como codificar HTML um valor que potencialmente codifica código não seguro. O código reside no arquivo code-behind de uma página da Web. O valor a ser codificado é codificado neste exemplo apenas para simplificar o exemplo e mostrar o tipo de valor que você pode codificar HTML. Normalmente, você codificaria HTML um valor que recebeu do usuário ou da solicitação. Result refere-se a um Literal controle.

public partial class _Default : Page
{        
    protected void Page_Load(object sender, EventArgs e)
    {
        Result.Text = Server.HtmlEncode("<script>unsafe</script>");      
    } 
}

Public Class _Default
    Inherits Page

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
        Result.Text = Server.HtmlEncode("<script>unsafe</script>")
    End Sub
End Class

O exemplo a seguir é semelhante ao exemplo anterior, exceto que mostra como codificar HTML de um valor de dentro de uma classe que não está no arquivo code-behind.

public class SampleClass
{
    public string GetEncodedText()
    {
        return HttpContext.Current.Server.HtmlEncode("<script>unsafe</script>");
    }
}

Public Class SampleClass
    Public Function GetEncodedText() As String
        Return HttpContext.Current.Server.HtmlEncode("<script>unsafe</script>")
    End Function
End Class

Comentários

A codificação HTML garante que o texto seja exibido corretamente no navegador e não interpretado pelo navegador como HTML. Por exemplo, se uma cadeia de caracteres de texto contiver um sinal menor que (<) or greater than sign (>), o navegador interpretará esses caracteres como o colchete de abertura ou fechamento de uma marca HTML. Quando os caracteres são codificados em HTML, eles são convertidos nas cadeias de caracteres < e >, o que faz com que o navegador exiba o sinal menor que e maior que o sinal corretamente.

Esse método é uma maneira conveniente de acessar o HttpUtility.HtmlEncode método em tempo de execução de um aplicativo ASP.NET. Internamente, esse método usa para codificar cadeias HttpUtility.HtmlEncode de caracteres.

No arquivo code-behind de uma página da Web ASP.NET, acesse uma instância da HttpServerUtility classe por meio da Server propriedade. Em uma classe que não está em um arquivo code-behind, use HttpContext.Current.Server para acessar uma instância da HttpServerUtility classe.

Fora de um aplicativo Web, use a WebUtility classe para codificar ou decodificar valores.

HtmlEncode(String, TextWriter)

Codifica uma cadeia de caracteres em HTML e envia a saída resultante para um fluxo de saída TextWriter.

public:
 void HtmlEncode(System::String ^ s, System::IO::TextWriter ^ output);

public void HtmlEncode (string s, System.IO.TextWriter output);

member this.HtmlEncode : string * System.IO.TextWriter -> unit

Public Sub HtmlEncode (s As String, output As TextWriter)

Parâmetros

s

String

A cadeia de caracteres a ser codificada.

output

TextWriter

O fluxo de saída TextWriter que contém a cadeia de caracteres codificada.

Exemplos

O exemplo a seguir codifica uma cadeia de caracteres para transmissão por HTTP. Ele codifica a cadeia de caracteres chamada TestString, que contém o texto "This is a <Test String>.", e copia-a para a cadeia de caracteres chamada EncodedString "This is a <Test String>".

String TestString = "This is a <Test String>.";
StringWriter writer = new StringWriter();
Server.HtmlEncode(TestString, writer);
String EncodedString = writer.ToString();

Dim TestString As String = "This is a <Test String>."
Dim writer As New StringWriter
Server.HtmlEncode(TestString, writer)
Dim EncodedString As String = writer.ToString()
   

Comentários

A codificação HTML garante que o texto seja exibido corretamente no navegador, não interpretado pelo navegador como HTML. Por exemplo, se uma cadeia de caracteres de texto contiver um sinal menor que (<) or greater than sign (>), o navegador interpretará esses caracteres como um colchete de abertura ou fechamento de uma marca HTML. A codificação HTML desses dois caracteres é < e >, respectivamente, o que faz com que o navegador exiba o sinal menor que e maior que o sinal corretamente.

HtmlEncodeé uma maneira conveniente de acessar o HttpUtility.HtmlEncode método em tempo de execução de um aplicativo ASP.NET. Internamente, HtmlEncode usa para codificar cadeias HttpUtility.HtmlEncode de caracteres.

Para codificar ou decodificar valores fora de um aplicativo Web, use a classe WebUtility.