Gets a reference to a collection of caching parameters for this user control.
(in System.Web.dll)
Visual Basic (Declaration)
<BrowsableAttribute(False)> _
Public ReadOnly Property CachePolicy As ControlCachePolicy
Dim instance As UserControl
Dim value As ControlCachePolicy
value = instance.CachePolicy
[BrowsableAttribute(false)]
public ControlCachePolicy CachePolicy { get; }
[BrowsableAttribute(false)]
public:
property ControlCachePolicy^ CachePolicy {
ControlCachePolicy^ get ();
}
public function get CachePolicy () : ControlCachePolicy
The CachePolicy property defines the cache parameters for the instance of the UserControl class. The CachePolicy property is read-only; however, you can set the properties of the ControlCachePolicy object that it returns.
The CachePolicy property can not be set declaratively. It must be set programmatically.
The following code example demonstrates how to use the SupportsCaching property to determine whether the user control can be cached, and if so, sets the Duration property to cache the control for 10 seconds.
<%@ page language="VB"%>
<%@ register src="SimpleControlvb.ascx"
tagname="SimpleControl"
tagprefix="uc1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
If SimpleControl1 IsNot Nothing Then
Page.DataBind()
If SimpleControl1.CachePolicy.SupportsCaching Then
' Set the cache duration to 10 seconds.
SimpleControl1.CachePolicy.Duration = New TimeSpan(0, 0, 10)
End If
End If
End Sub
</script>
<%@ page language="C#"%>
<%@ register src="SimpleControlcs.ascx"
tagname="SimpleControl"
tagprefix="uc1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void Page_Init(object sender, EventArgs e)
{
// If the control is already in the cache, calling properties
// will throw an exception. Make sure the control is available.
if (SimpleControl1 != null)
{
Page.DataBind();
if (SimpleControl1.CachePolicy.SupportsCaching)
{
// Set the cache duration to 10 seconds.
SimpleControl1.CachePolicy.Duration = new TimeSpan(0, 0, 10);
}
}
}
</script>
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference
Other Resources