WriteSubstitution Method

HttpResponse.WriteSubstitution Method

Allows insertion of response substitution blocks into the response, which allows dynamic generation of specified response regions for output cached responses.

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

public void WriteSubstitution (
	HttpResponseSubstitutionCallback callback
)
public void WriteSubstitution (
	HttpResponseSubstitutionCallback callback
)
public function WriteSubstitution (
	callback : HttpResponseSubstitutionCallback
)
Not applicable.

Parameters

callback

The method, user control, or object to substitute.

Exception typeCondition

ArgumentException

The target of callback is of type Control.

You can use the WriteSubstitution method for post-cache substitution in your output-cached pages. By passing an HttpContext object to a callback method with a prescribed HttpResponseSubstitutionCallback signature, you can replace output cached content at any given location in the page cache. To initiate the replacement, call the WriteSubstitution method, passing it the callback method, which must be thread safe and can be either of the following:

  • A static method on the containing page or user control.

  • A static or instance method on another arbitrary object.

On the first request to the page, the WriteSubstitution calls the HttpResponseSubstitutionCallback delegate to produce the output. Then, it adds a substitution buffer to the response, which retains the delegate to call on future requests. Finally, it degrades client-side cacheability from public to server-only, ensuring future requests to the page re-invoke the delegate by not caching on the client.

NoteNote:

Post-cache substitution is not supported for a cached user control where output caching is applied at the user control level. This is also known as fragment caching. For more information, see Caching Portions of an ASP.NET Page.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2016 Microsoft