Export (0) Print
Expand All

HttpServerUtility Class

Provides helper methods for processing Web requests.

System.Object
  System.Web.HttpServerUtility

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)

public sealed class HttpServerUtility

The HttpServerUtility type exposes the following members.

  NameDescription
Public propertyMachineNameGets the server's computer name.
Public propertyScriptTimeoutGets and sets the request time-out value in seconds.
Top

  NameDescription
Public methodClearErrorClears the previous exception.
Public methodCreateObject(String)Creates a server instance of a COM object identified by the object's programmatic identifier (ProgID).
Public methodCreateObject(Type)Creates a server instance of a COM object identified by the object's type.
Public methodCreateObjectFromClsidCreates a server instance of a COM object identified by the object's class identifier (CLSID).
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecute(String)Executes the handler for the specified virtual path in the context of the current request.
Public methodExecute(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.
Public methodExecute(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.
Public methodExecute(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.
Public methodExecute(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.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLastErrorReturns the previous exception.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHtmlDecode(String)Decodes an HTML-encoded string and returns the decoded string.
Public methodHtmlDecode(String, TextWriter)Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream.
Public methodHtmlEncode(String)HTML-encodes a string and returns the encoded string.
Public methodHtmlEncode(String, TextWriter)HTML-encodes a string and sends the resulting output to a TextWriter output stream.
Public methodMapPathReturns the physical file path that corresponds to the specified virtual path.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransfer(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.
Public methodTransfer(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.
Public methodTransfer(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.
Public methodTransferRequest(String)Performs an asynchronous execution of the specified URL.
Public methodTransferRequest(String, Boolean)Performs an asynchronous execution of the specified URL and preserves query string parameters.
Public methodTransferRequest(String, Boolean, String, NameValueCollection)Performs an asynchronous execution of the specified URL using the specified HTTP method and headers.
Public methodTransferRequest(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.
Public methodUrlDecode(String)URL-decodes a string and returns the decoded string.
Public methodUrlDecode(String, TextWriter)Decodes an HTML string received in a URL and sends the resulting output to a TextWriter output stream.
Public methodUrlEncode(String)URL-encodes a string and returns the encoded string.
Public methodUrlEncode(String, TextWriter)URL-encodes a string and sends the resulting output to a TextWriter output stream.
Public methodUrlPathEncodeDo not use; intended only for browser compatibility. Use UrlEncode.
Public methodStatic memberUrlTokenDecodeDecodes a URL string token to its equivalent byte array using base 64 digits.
Public methodStatic memberUrlTokenEncodeEncodes a byte array into its equivalent string representation using base 64 digits, which is usable for transmission on the URL.
Top

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

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>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft