Export (0) Print
Expand All

UserControl.CachePolicy Property

Gets a reference to a collection of caching parameters for this user control.

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

<BrowsableAttribute(False)> _
Public ReadOnly Property CachePolicy As ControlCachePolicy

Property Value

Type: System.Web.UI.ControlCachePolicy
A ControlCachePolicy containing properties that define the caching parameters for this UserControl.

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 cannot 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" 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">
  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

    If SimpleControl1 IsNot Nothing Then


      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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

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.

© 2014 Microsoft