HttpServerUtility.HtmlEncode 方法

定義

命名空間:

System.Web

組件:

System.Web.dll

編碼一個字串，讓它在瀏覽器中顯示。

若要在網頁應用程式外編碼或解碼數值，請使用 該 WebUtility 類別。

多載

名稱	Description
HtmlEncode(String)	HTML 編碼一個字串，並回傳編碼後的字串。
HtmlEncode(String, TextWriter)	HTML 編碼一個字串，並將所得輸出傳送到輸出 TextWriter 串流。

HtmlEncode(String)

HTML 編碼一個字串，並回傳編碼後的字串。

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

參數

s

String

要進行編碼的文字字串。

傳回

String

HTML編碼的文字。

範例

以下範例展示了如何用 HTML 編碼一個可能編碼不安全程式碼的值。 程式碼存在於網頁的程式碼背後檔案中。 這個範例中要編碼的值是硬編碼的，目的是簡化範例並展示你可能用 HTML 編碼的值類型。 通常，你會用 HTML 編碼你從使用者或請求那裡收到的值。 Result指的是控制。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

下一個範例與前一個範例相似，但它展示了如何從類別中以 HTML 編碼一個不在程式碼背後檔案中的值。

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

備註

HTML 編碼確保文字在瀏覽器中正確顯示，而不會被瀏覽器解讀為 HTML。 例如，若文字串包含小於符號（<）或大於符號（>）的字元，瀏覽器會將這些字元解讀為HTML標籤的開括號或閉括號。 當字元以 HTML 編碼時，會被轉換成字串 < 和 >，這會導致瀏覽器正確顯示小於符號和大於符號的符號。

此方法是從 ASP.NET 應用程式在執行時存取 HttpUtility.HtmlEncode 方法的方便方式。 在內部，此方法用於 HttpUtility.HtmlEncode 編碼字串。

在 ASP.NET 網頁的程式碼背後檔案中，透過 HttpServerUtility 屬性存取 Server 類別的實例。 在不包含程式碼後方檔案的類別中，使用 來 HttpContext.Current.Server 存取該 HttpServerUtility 類別的實例。

在網頁應用程式之外，使用 WebUtility 該類別來編碼或解碼數值。

HtmlEncode(String, TextWriter)

HTML 編碼一個字串，並將所得輸出傳送到輸出 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)

參數

s

String

要編碼的字串。

output

TextWriter

包含編碼字串的 TextWriter 輸出串流。

範例

以下範例編碼一個字串，供 HTTP 傳輸。 它編碼名為 TestString的字串，其中包含「This is <a Test String>.」的文字，並將其複製到名為 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()
   

備註

HTML 編碼確保文字在瀏覽器中正確顯示，而不會被瀏覽器解讀為 HTML。 例如，若文字串包含小於符號（<）或大於符號（>）的字元，瀏覽器會將這些字元解讀為HTML標籤的開括號或閉括號。 這兩個字元的 HTML 編碼分別為 < 和 >，這會使瀏覽器正確顯示小於符號和大於符號的符號。

HtmlEncode 是從 ASP.NET 應用程式在執行時方便存取 HttpUtility.HtmlEncode 方法的方法。 內部用 HtmlEncodeHttpUtility.HtmlEncode 來編碼字串。

若要在網頁應用程式外編碼或解碼數值，請使用 該 WebUtility 類別。