HttpServerUtility HttpServerUtility HttpServerUtility HttpServerUtility Class

Definition

Provides helper methods for processing Web requests.

public ref class HttpServerUtility sealed
public sealed class HttpServerUtility
type HttpServerUtility = class
Public NotInheritable Class HttpServerUtility
Inheritance
HttpServerUtilityHttpServerUtilityHttpServerUtilityHttpServerUtility

Examples

A Visual Studio Web site project with source code is available to accompany this topic: Download.

The following example demonstrates how to use the HtmlEncode method and the UrlEncode method of the HttpServerUtility class. The HtmlEncode method helps ensure that any user-supplied string input will be rendered as static text in browsers instead of executable script or HTML elements. The UrlEncode method encodes URLs so that they are correctly transmitted in the HTTP stream.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    protected void Button1_Click(object sender, EventArgs e)
    {
        if (!String.IsNullOrEmpty(TextBox1.Text))
        {
            // Access the HttpServerUtility methods through
            // the intrinsic Server object.
            Label1.Text = "Welcome, " +
                Server.HtmlEncode(TextBox1.Text) +
                ".<br/> The url is " + 
                Server.UrlEncode(Request.Url.ToString());
        }
    }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpServerUtility Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        Enter your name:<br />

        <asp:TextBox ID="TextBox1" runat="server"></asp:TextBox>
        <asp:Button ID="Button1" runat="server" OnClick="Button1_Click" Text="Submit" />
        <br />
        <asp:Label ID="Label1" runat="server"/>
        </div>
    </form>
</body>
</html>
<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    Protected Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)

        If (Not String.IsNullOrEmpty(TextBox1.Text)) Then
            
            ' Access the HttpServerUtility methods through
            ' the intrinsic Server object.
            Label1.Text = "Welcome, " & _
                Server.HtmlEncode(TextBox1.Text) & _
                ".<br/> The url is " & _
                Server.UrlEncode(Request.Url.ToString())
        End If
        
        
        
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>HttpServerUtility Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        Enter your name:<br />

        <asp:TextBox ID="TextBox1" runat="server"></asp:TextBox>
        <asp:Button ID="Button1" runat="server" OnClick="Button1_Click" Text="Submit" />
        <br />
        <asp:Label ID="Label1" runat="server"/>
        </div>
    </form>
</body>
</html>

Remarks

The methods and properties of the HttpServerUtility class are exposed through the intrinsic Server object provided by ASP.NET.

Properties

MachineName MachineName MachineName MachineName

Gets the server's computer name.

ScriptTimeout ScriptTimeout ScriptTimeout ScriptTimeout

Gets and sets the request time-out value in seconds.

Methods

ClearError() ClearError() ClearError() ClearError()

Clears the previous exception.

CreateObject(String) CreateObject(String) CreateObject(String) CreateObject(String)

Creates a server instance of a COM object identified by the object's programmatic identifier (ProgID).

CreateObject(Type) CreateObject(Type) CreateObject(Type) CreateObject(Type)

Creates a server instance of a COM object identified by the object's type.

CreateObjectFromClsid(String) CreateObjectFromClsid(String) CreateObjectFromClsid(String) CreateObjectFromClsid(String)

Creates a server instance of a COM object identified by the object's class identifier (CLSID).

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute(IHttpHandler, TextWriter, Boolean) Execute(IHttpHandler, TextWriter, Boolean) Execute(IHttpHandler, TextWriter, Boolean) Execute(IHttpHandler, TextWriter, Boolean)

Executes the handler for the specified virtual path in the context of the current request. A TextWriter captures output from the executed handler and a Boolean parameter specifies whether to clear the QueryString and Form collections.

Execute(String) Execute(String) Execute(String) Execute(String)

Executes the handler for the specified virtual path in the context of the current request.

Execute(String, Boolean) Execute(String, Boolean) Execute(String, Boolean) Execute(String, Boolean)

Executes the handler for the specified virtual path in the context of the current request and specifies whether to clear the QueryString and Form collections.

Execute(String, TextWriter) Execute(String, TextWriter) Execute(String, TextWriter) Execute(String, TextWriter)

Executes the handler for the specified virtual path in the context of the current request. A TextWriter captures output from the executed handler.

Execute(String, TextWriter, Boolean) Execute(String, TextWriter, Boolean) Execute(String, TextWriter, Boolean) Execute(String, TextWriter, Boolean)

Executes the handler for the specified virtual path in the context of the current request. A TextWriter captures output from the page and a Boolean parameter specifies whether to clear the QueryString and Form collections.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLastError() GetLastError() GetLastError() GetLastError()

Returns the previous exception.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
HtmlDecode(String) HtmlDecode(String) HtmlDecode(String) HtmlDecode(String)

Decodes an HTML-encoded string and returns the decoded string.

HtmlDecode(String, TextWriter) HtmlDecode(String, TextWriter) HtmlDecode(String, TextWriter) HtmlDecode(String, TextWriter)

Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream.

HtmlEncode(String) HtmlEncode(String) HtmlEncode(String) HtmlEncode(String)

HTML-encodes a string and returns the encoded string.

HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter)

HTML-encodes a string and sends the resulting output to a TextWriter output stream.

MapPath(String) MapPath(String) MapPath(String) MapPath(String)

Returns the physical file path that corresponds to the specified virtual path.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Transfer(IHttpHandler, Boolean) Transfer(IHttpHandler, Boolean) Transfer(IHttpHandler, Boolean) Transfer(IHttpHandler, Boolean)

Terminates execution of the current page and starts execution of a new request by using a custom HTTP handler that implements the IHttpHandler interface and specifies whether to clear the QueryString and Form collections.

Transfer(String) Transfer(String) Transfer(String) Transfer(String)

For the current request, terminates execution of the current page and starts execution of a new page by using the specified URL path of the page.

Transfer(String, Boolean) Transfer(String, Boolean) Transfer(String, Boolean) Transfer(String, Boolean)

Terminates execution of the current page and starts execution of a new page by using the specified URL path of the page. Specifies whether to clear the QueryString and Form collections.

TransferRequest(String) TransferRequest(String) TransferRequest(String) TransferRequest(String)

Performs an asynchronous execution of the specified URL.

TransferRequest(String, Boolean) TransferRequest(String, Boolean) TransferRequest(String, Boolean) TransferRequest(String, Boolean)

Performs an asynchronous execution of the specified URL and preserves query string parameters.

TransferRequest(String, Boolean, String, NameValueCollection) TransferRequest(String, Boolean, String, NameValueCollection) TransferRequest(String, Boolean, String, NameValueCollection) TransferRequest(String, Boolean, String, NameValueCollection)

Performs an asynchronous execution of the specified URL using the specified HTTP method and headers.

TransferRequest(String, Boolean, String, NameValueCollection, Boolean) TransferRequest(String, Boolean, String, NameValueCollection, Boolean) TransferRequest(String, Boolean, String, NameValueCollection, Boolean) TransferRequest(String, Boolean, String, NameValueCollection, Boolean)

Performs an asynchronous execution of the specified URL using the specified HTTP method, headers, and path, and optionally preserves form values and the user identity.

UrlDecode(String) UrlDecode(String) UrlDecode(String) UrlDecode(String)

URL-decodes a string and returns the decoded string.

UrlDecode(String, TextWriter) UrlDecode(String, TextWriter) UrlDecode(String, TextWriter) UrlDecode(String, TextWriter)

Decodes an HTML string received in a URL and sends the resulting output to a TextWriter output stream.

UrlEncode(String) UrlEncode(String) UrlEncode(String) UrlEncode(String)

URL-encodes a string and returns the encoded string.

UrlEncode(String, TextWriter) UrlEncode(String, TextWriter) UrlEncode(String, TextWriter) UrlEncode(String, TextWriter)

URL-encodes a string and sends the resulting output to a TextWriter output stream.

UrlPathEncode(String) UrlPathEncode(String) UrlPathEncode(String) UrlPathEncode(String)

Do not use; intended only for browser compatibility. Use UrlEncode(String).

UrlTokenDecode(String) UrlTokenDecode(String) UrlTokenDecode(String) UrlTokenDecode(String)

Decodes a URL string token to its equivalent byte array using base 64 digits.

UrlTokenEncode(Byte[]) UrlTokenEncode(Byte[]) UrlTokenEncode(Byte[]) UrlTokenEncode(Byte[])

Encodes a byte array into its equivalent string representation using base 64 digits, which is usable for transmission on the URL.

Applies to

See Also