Export (0) Print
Expand All

HttpResponse.Filter Property

Gets or sets a wrapping filter object used to modify the HTTP entity body before transmission.

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

public Stream Filter { get; set; }
/** @property */
public Stream get_Filter ()

/** @property */
public void set_Filter (Stream value)

public function get Filter () : Stream

public function set Filter (value : Stream)

Property Value

The Stream object that acts as the output filter.

Exception typeCondition

HttpException

Filtering is not allowed with the entity.

When you create a Stream object and set the Filter property to the Stream object, all HTTP output sent by Write passes through the filter.

The following code example is an ASP.NET page that sets the Filter property to a new instance of the UpperCaseFilter class, a custom Stream class that converts all text that passes through it to uppercase. The information on the request is saved to a text file, and then the Filter property is set. After the response filter is in place, the code calls the MapPath method to get the absolute path to a text file, named TestFile.txt, that serves as the source for the content of the response. The code then creates a new StreamReader object to read the text file from beginning to end, and then calls the Write method to display the content of the file on the page.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.IO" %>
<%@ import Namespace="Samples.AspNet.CS.Controls"  %>
<script runat="server">

    private void Page_Load(object sender, EventArgs e)
    {

      // Filter the text to be rendered as all uppercase.
      Response.Filter = new UpperCaseFilterStream(Response.Filter);

      // Convert a virtual path to a fully qualified physical path.
      string fullpath = Request.MapPath("~\\TestFile.txt");

      try
      {
        // Read the contents of the file using a StreamReader.
        using (StreamReader sr = new StreamReader(fullpath))
        while (sr.Peek() >= 0)
        {
          Response.Write((char)sr.Read());
        }
        Message.Text = "Reading the file was successful.";
        
      }
      catch (Exception ex)
      {
        Message.Text = "The process failed.";
      }    
     }

</script>
<html>
  <head>
    <title>HttpResponse.MapPath Example</title>
  </head>
  <body>
    <form runat="server">

      <asp:Label id="Message" 
                 runat="server"/>

    </form>
  </body>
</html>


<%@ Page Language="VJ#" %>
<%@ import Namespace="Samples.AspNet" %>
<script runat="server">

    private void Page_Load(Object sender, EventArgs e)
    {
       
       // Filter the text to be rendered as all uppercase.
       get_Response().set_Filter(new UpperCaseFilterStream(get_Response().
           get_Filter()));
    
    } //Page_Load

</script>
<html>
<head>
</head>
<body>
    <% get_Response().Write("This text will be rendered all uppercase." ); %>
</body>
</html>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft