HttpServerUtility.HtmlEncode Método

Definición

Espacio de nombres:

System.Web

Ensamblado:

System.Web.dll

Codifica una cadena que se va a mostrar en un explorador.

Para codificar o descodificar valores fuera de una aplicación web, use la clase WebUtility.

Sobrecargas

HtmlEncode(String)	Codifica html una cadena y devuelve la cadena codificada.
HtmlEncode(String, TextWriter)	Codifica HTML una cadena y envía la salida resultante a un flujo de salida de TextWriter.

HtmlEncode(String)

Codifica html una cadena y devuelve la cadena 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

Cadena de texto que se va a codificar.

Devoluciones

String

Texto codificado en HTML.

Ejemplos

En el ejemplo siguiente se muestra cómo codificar HTML un valor que podría codificar código no seguro. El código reside en el archivo de código subyacente de una página web. El valor que se va a codificar de forma rígida en este ejemplo solo para simplificar el ejemplo y mostrar el tipo de valor que podría codificar HTML. Normalmente, codificaría HTML un valor que recibió del usuario o la solicitud. Result hace referencia a un control Literal.

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

El ejemplo siguiente es similar al ejemplo anterior, salvo que muestra cómo codificar html un valor desde dentro de una clase que no está en el archivo de código subyacente.

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

Comentarios

La codificación HTML garantiza que el texto se muestre correctamente en el explorador y que el explorador no lo interprete como HTML. Por ejemplo, si una cadena de texto contiene un signo menor que (<) o mayor que el signo (>), el explorador interpretaría estos caracteres como corchete de apertura o cierre de una etiqueta HTML. Cuando los caracteres están codificados en HTML, se convierten en las cadenas < y >, lo que hace que el explorador muestre el signo menor y mayor que el signo correctamente.

Este método es una manera cómoda de acceder al método HttpUtility.HtmlEncode en tiempo de ejecución desde una aplicación de ASP.NET. Internamente, este método usa HttpUtility.HtmlEncode para codificar cadenas.

En el archivo de código subyacente de una página web de ASP.NET, acceda a una instancia de la clase HttpServerUtility a través de la propiedad Server. En una clase que no está en un archivo de código subyacente, use HttpContext.Current.Server para acceder a una instancia de la clase HttpServerUtility.

Fuera de una aplicación web, use la clase WebUtility para codificar o descodificar valores.

HtmlEncode(String, TextWriter)

Codifica HTML una cadena y envía la salida resultante a un flujo de salida de 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

Cadena que se va a codificar.

output

TextWriter

Flujo de salida TextWriter que contiene la cadena codificada.

Ejemplos

En el ejemplo siguiente se codifica una cadena para la transmisión por HTTP. Codifica la cadena denominada TestString, que contiene el texto "This is a <Test String>.", y lo copia en la cadena denominada EncodedString como "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()
   

Comentarios

La codificación HTML garantiza que el texto se mostrará correctamente en el explorador, no interpretado por el explorador como HTML. Por ejemplo, si una cadena de texto contiene un signo menor que (<) o mayor que el signo (>), el explorador interpretaría estos caracteres como un corchete de apertura o cierre de una etiqueta HTML. La codificación HTML de estos dos caracteres es < y >, respectivamente, lo que hace que el explorador muestre el signo menor y mayor que el signo correctamente.

HtmlEncode es una manera cómoda de acceder al método HttpUtility.HtmlEncode en tiempo de ejecución desde una aplicación de ASP.NET. Internamente, HtmlEncode usa HttpUtility.HtmlEncode para codificar cadenas.

Para codificar o descodificar valores fuera de una aplicación web, use la clase WebUtility.