HttpResponseSubstitutionCallback Delegate


Represents the method that handles post-cache substitution.

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

public delegate String^ HttpResponseSubstitutionCallback(
	HttpContext^ context


Type: System.Web::HttpContext^

The HttpContext that contains the HTTP request information for the page with the control that requires post-cache substitution.

Return Value

Type: System::String^

The content inserted into the cached response before being sent to the client.

The HttpResponseSubstitutionCallback delegate, in combination with the WriteSubstitution method, is used for rendering post-cache content for the Substitution and AdRotator controls.

For the Substitution control, use the MethodName property to specify the name of the callback method to invoke when the Substitution control executes. The callback method that you specify must be a static method on the page or on the user control that contains the Substitution control. The signature for the callback method must match the signature for an HttpResponseSubstitutionCallback delegate that takes an HttpContext parameter and returns a string.

For the AdRotator control, rendering is independent of the page caching unless an event handler is provided for the AdCreated event. If no AdCreated event handler is present, post-cache substitution is used to render the AdRotator content.

The following code example demonstrates how to add a Substitution control programmatically to an output-cached Web page. When the page loads, the current date and time are displayed to the user in a label. This section of the page is cached and updated every 60 seconds. When the Substitution control executes, it calls the GetCurrentDateTime method, which must match the signature for the HttpResponseSubstitutionCallback delegate. The string that is returned by the GetCurrentDateTime method is displayed to the user. This section of the page is not cached and is updated each time the page is refreshed. The MethodName property of the Substitution control gets or sets the name of the callback method.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top