Specifies a section on an output-cached Web page that is exempt from caching. At this location, dynamic content is retrieved and substituted for the Substitution control.
Assembly: System.Web (in System.Web.dll)
Syntax
Public Class Substitution _
Inherits [%$TOPIC/9ze89as6_en-us_VS_110_2_0_0_0_0%]public class Substitution : [%$TOPIC/9ze89as6_en-us_VS_110_2_0_1_0_0%]public ref class Substitution : public [%$TOPIC/9ze89as6_en-us_VS_110_2_0_2_0_0%]type Substitution =
class
inherit [%$TOPIC/9ze89as6_en-us_VS_110_2_0_3_0_0%]
end<asp:Substitution />The Substitution type exposes the following members.
Constructors
Top
| Name | Description | |
|---|---|---|
.gif) | Substitution | Initializes a new instance of the Substitution class. |
Properties
Top
| Name | Description | |
|---|---|---|
.gif) | Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
.gif) | AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
| BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
| ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
| ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) |
|
| ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) |
|
| ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
| Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
| Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) |
|
| DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) |
|
| DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) |
|
| DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
| EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from Control.) |
|
| EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) |
|
| Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
| HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
| ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
| IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
| IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
| IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
| IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
| LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
| MethodName | Gets or sets the name of the callback method to invoke when the Substitution control executes. |
|
| NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ControlID property value. (Inherited from Control.) |
|
| Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
| Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
|
| Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
| SkinID | Gets or sets the skin to apply to the control. (Inherited from Control.) |
|
| TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
| TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
| ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.) |
|
| ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) |
|
| ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
| ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) |
|
| Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
Methods
Top
| Name | Description | |
|---|---|---|
.gif) | AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
| AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) |
|
| ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
|
| BeginRenderTracing | Begins design-time tracing of rendering data. (Inherited from Control.) |
|
| BuildProfileTree | Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) |
|
| ClearCachedClientID | Infrastructure. Sets the cached ClientID value to . (Inherited from Control.) |
|
| ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
| ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
| ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
| ClearEffectiveClientIDMode | Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) |
|
| CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.) |
|
| CreateControlCollection | Returns an EmptyControlCollection object, indicating that the Substitution control does not support child controls. (Overrides ControlCreateControlCollection.) |
|
| DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) |
|
| DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) |
|
| DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
| Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
| EndRenderTracing | Ends design-time tracing of rendering data. (Inherited from Control.) |
|
| EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
| EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
| FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) |
|
| FindControl(String, Int32) | Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) |
|
| Focus | Sets input focus to a control. (Inherited from Control.) |
|
| GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
| GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
| GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
| GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
| GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
| GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
|
| HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
|
| HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
| IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
| LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
|
| LoadViewState | Restores view-state information from a previous page request that was saved by the SaveViewState method. (Inherited from Control.) |
|
| MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
| OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
|
| OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
|
| OnInit | Raises the Init event. (Inherited from Control.) |
|
| OnLoad | Raises the Load event. (Inherited from Control.) |
|
| OnPreRender | Raises the PreRender event. (Overrides ControlOnPreRender(EventArgs).) |
|
| OnUnload | Raises the Unload event. (Inherited from Control.) |
|
| OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
| RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
| RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
| Render | Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Overrides ControlRender(HtmlTextWriter).) |
|
| RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
|
| RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) |
|
| RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) |
|
| ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
| ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
| ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
| SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
|
| SaveViewState | Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
|
| SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
|
| SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
| SetTraceData(Object, Object) | Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control.) |
|
| SetTraceData(Object, Object, Object) | Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control.) |
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
| TrackViewState | Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ControlViewState property. (Inherited from Control.) |
Events
Top
| Name | Description | |
|---|---|---|
.gif) | DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
| Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
|
| Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
| Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
| PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
| Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
Extension Methods
Top
| Name | Description | |
|---|---|---|
.gif) | FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
| FindFieldTemplate | Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
| FindMetaTable | Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.) |
Explicit Interface Implementations
.gif)
.gif)
.gif)
Remarks
In this topic:
Introduction
Declarative Syntax
Introduction
Use the Substitution control to specify a section on an output-cached Web page where you want dynamic content substituted for the control. The Substitution control offers a simplified solution to partial page caching for pages where the majority of the content is cached. You can output-cache the entire page, and then use Substitution controls to specify the parts of the page that are exempt from caching. Cached regions execute only once and are replayed from the cache until the cache entry expires or is purged. Dynamic regions execute each time the page is requested. This caching model simplifies the code for pages that are primarily static, because you do not have to encapsulate the sections to cache in Web user controls. For example, this caching model is useful in a scenario where you have a page that contains static content, such as news stories, and an AdRotator control that displays advertisements. The news stories do not change, which means that they can be cached. However, each time a user requests the page, you want to display a new advertisement. The AdRotator control directly supports post-cache substitution and renders a new advertisement each time the page posts back, regardless of whether the page is cached.
.gif) Note |
|---|
You can place a Substitution control in a user control that is contained in a cached page. However, you cannot place a Substitution control in an output-cached user control. |
When the Substitution control executes, it calls a method that returns a string. The string that the method returns is the content to display on the page at the location of 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 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.
To manipulate the output cache for a page, you can use the @ OutputCache directive, the HttpCachePolicy class, or the Cache property. For more information on caching pages, see Caching ASP.NET Pages and Caching Portions of an ASP.NET Page.
As an alternative to using the Substitution control, you can also get substitution caching behavior using a HttpResponseSubstitutionCallback delegate. In addition, you can get substitution caching behavior on controls, such as the AdRotator control, that directly support this feature. For more information, see Dynamically Updating Portions of a Cached Page.
Declarative Syntax
<asp:Substitution
EnableTheming="True|False"
EnableViewState="True|False"
ID="string"
MethodName="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
runat="server"
SkinID="string"
Visible="True|False"
/>
Examples
The following code example demonstrates how to add a Substitution control declaratively 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 only every 60 seconds. When the Substitution control executes, it calls the GetCurrentDateTime method. The string returned by GetCurrentDateTime is displayed to the user. This section of the page is not cached and is updated each time the page is refreshed.
<%@ outputcache duration="60" varybyparam="none" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server" language="VB">
Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
' Display the current date and time in the label.
' Output caching applies to this section of the page.
CachedDateLabel.Text = DateTime.Now.ToString()
End Sub
' The Substitution control calls this method to retrieve
' the current date and time. This section of the page
' is exempt from output caching.
Shared Function GetCurrentDateTime(ByVal context As HttpContext) As String
Return DateTime.Now.ToString()
End Function
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Substitution Class Example</title>
</head>
<body>
<form id="Form1" runat="server">
<h3>Substitution Class Example</h3>
<p>This section of the page is not cached:</p>
<asp:substitution id="Substitution1"
methodname="GetCurrentDateTime"
runat="Server">
</asp:substitution>
<br />
<p>This section of the page is cached:</p>
<asp:label id="CachedDateLabel"
runat="Server">
</asp:label>
<br /><br />
<asp:button id="RefreshButton"
text="Refresh Page"
runat="Server">
</asp:button>
</form>
</body>
</html><%@ outputcache duration="60" varybyparam="none" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server" language="C#">
void Page_Load(object sender, System.EventArgs e)
{
// Display the current date and time in the label.
// Output caching applies to this section of the page.
CachedDateLabel.Text = DateTime.Now.ToString();
}
// The Substitution control calls this method to retrieve
// the current date and time. This section of the page
// is exempt from output caching.
public static string GetCurrentDateTime (HttpContext context)
{
return DateTime.Now.ToString ();
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Substitution Class Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>Substitution Class Example</h3>
<p>This section of the page is not cached:</p>
<asp:substitution id="Substitution1"
methodname="GetCurrentDateTime"
runat="Server">
</asp:substitution>
<br />
<p>This section of the page is cached:</p>
<asp:label id="CachedDateLabel"
runat="Server">
</asp:label>
<br /><br />
<asp:button id="RefreshButton"
text="Refresh Page"
runat="Server">
</asp:button>
</form>
</body>
</html>
Platforms
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.
See Also
