UserControl.CachePolicy Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

public ControlCachePolicy CachePolicy { get; }

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="C#"%>
<%@ register src="SimpleControlcs.ascx" 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<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)


    if (SimpleControl1.CachePolicy.SupportsCaching)
      // Set the cache duration to 10 seconds.
      SimpleControl1.CachePolicy.Duration = new TimeSpan(0, 0, 10);



.NET Framework
Available since 2.0
Return to top