Provides programmatic access to an ASP.NET user control's output cache settings.
Assembly: System.Web (in System.Web.dll)
Thetype exposes the following members.
|Cached||Gets or sets a value indicating whether fragment caching is enabled for the user control.|
|Dependency||Gets or sets an instance of the CacheDependency class associated with the cached user control output.|
|Duration||Gets or sets the amount of time that cached items are to remain in the output cache.|
|ProviderName||Gets or sets the name of the output-cache provider that is associated with a control instance.|
|SupportsCaching||Gets a value indicating whether the user control supports caching.|
|VaryByControl||Gets or sets a list of control identifiers to vary the cached output by.|
|VaryByParams||Gets or sets a list of GET or POST parameter names to vary the cached output by.|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|GetHashCode||Serves as the default hash function. (Inherited from Object.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|SetExpires||Instructs the BasePartialCachingControl control that wraps the user control to expire the cache entry at the specified date and time.|
|SetSlidingExpiration||Instructs the BasePartialCachingControl control that wraps the user control to set the user control's cache entry to use sliding or absolute expiration.|
|SetVaryByCustom||Sets a list of custom strings that the output cache will use to vary the user control.|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
The class is used by developers in programmatic user control scenarios to specify output caching settings for user controls (.ascx files). ASP.NET embeds user controls within a BasePartialCachingControl instance. The BasePartialCachingControl class represents a user control that has output caching enabled. When you access the BasePartialCachingControl::CachePolicy property of a PartialCachingControl control, you will always receive a valid object. However, if you access the UserControl::CachePolicy property of a UserControl control, you receive a valid object only if the user control is already wrapped by a BasePartialCachingControl control. If it is not wrapped, the object returned by the property will throw exceptions when you attempt to manipulate it because it does not have an associated BasePartialCachingControl. To determine whether a UserControl instance supports caching without generating exceptions, inspect the SupportsCaching property.
Using the class is one of several ways you can enable output caching. The following list describes methods you can use to enable output caching:
Use the @ OutputCache directive to enable output caching in declarative scenarios.
Use the PartialCachingAttribute attribute to enable caching for a user control in a code-behind file.
Use the class to specify cache settings in programmatic scenarios in which you are working with BasePartialCachingControl instances that have been cache-enabled using one of the previous methods and dynamically loaded using the TemplateControl::LoadControl method. A instance can be successfully manipulated only between the Init and PreRender stages of the control life cycle. If you modify a object after the PreRender phase, ASP.NET throws an exception, because any changes made after the control is rendered cannot actually affect cache settings (a control is cached during the Render stage). Finally, a user control instance (and therefore its object) is only available for programmatic manipulation when it is actually rendered.
The following code example demonstrates how a user control can be loaded dynamically and manipulated programmatically at run time. The PartialCachingAttribute attribute is applied to a user control named SimpleControl, which means the user control is wrapped by a PartialCachingControl control at run time. The SimpleControl object's caching settings can be programmatically manipulated through its associated object, which is available through a reference to the PartialCachingControl control that wraps it. In this example, the Duration property is examined during page initialization and changed using the SetSlidingExpiration and SetExpires methods if some conditions are met.
The following code example demonstrates using the SimpleControl user control from a Web Forms page. To run this example successfully, make sure the user control file (.ascx), its code-behind file (.cs or .vb), and the Web Forms page that hosts the user control (.aspx) are in the same directory.
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.