1 out of 1 rated this helpful - Rate this topic

OutputCacheAttribute Class

Represents an attribute that is used to mark an action method whose output will be cached.

System.Object
  System.Attribute
    System.Web.Mvc.FilterAttribute
      System.Web.Mvc.ActionFilterAttribute
        System.Web.Mvc.OutputCacheAttribute

Namespace:  System.Web.Mvc
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
	AllowMultiple = false)]
public class OutputCacheAttribute : ActionFilterAttribute, 
	IExceptionFilter

The OutputCacheAttribute type exposes the following members.

  Name Description
Public method OutputCacheAttribute Initializes a new instance of the OutputCacheAttribute class.
Top
  Name Description
Public property AllowMultiple Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified. (Inherited from FilterAttribute.)
Public property CacheProfile Gets or sets the cache profile name.
Public property Static member ChildActionCache Gets or sets the child action cache.
Public property Duration Gets or sets the cache duration, in seconds.
Public property Location Gets or sets the location.
Public property NoStore Gets or sets a value that indicates whether to store the cache.
Public property Order Gets or sets the order in which the action filters are executed. (Inherited from FilterAttribute.)
Public property SqlDependency Gets or sets the SQL dependency.
Public property TypeId (Inherited from Attribute.)
Public property VaryByContentEncoding Gets or sets the vary-by-content encoding.
Public property VaryByCustom Gets or sets the vary-by-custom value.
Public property VaryByHeader Gets or sets the vary-by-header value.
Public property VaryByParam Gets or sets the vary-by-param value.
Top
  Name Description
Public method Equals (Inherited from Attribute.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Public method Static member IsChildActionCacheActive Returns a value that indicates whether a child action cache is active.
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnActionExecuted This method is an implementation of IActionFilter.OnActionExecuted and supports the ASP.NET MVC infrastructure. It is not intended to be used directly from your code. (Overrides ActionFilterAttribute.OnActionExecuted(ActionExecutedContext).)
Public method OnActionExecuting This method is an implementation of IActionFilter.OnActionExecuting and supports the ASP.NET MVC infrastructure. It is not intended to be used directly from your code. (Overrides ActionFilterAttribute.OnActionExecuting(ActionExecutingContext).)
Public method OnException This method is an implementation of IExceptionFilter.OnException and supports the ASP.NET MVC infrastructure. It is not intended to be used directly from your code.
Public method OnResultExecuted This method is an implementation of IResultFilter.OnResultExecuted and supports the ASP.NET MVC infrastructure. It is not intended to be used directly from your code. (Overrides ActionFilterAttribute.OnResultExecuted(ResultExecutedContext).)
Public method OnResultExecuting Called before the action result executes. (Overrides ActionFilterAttribute.OnResultExecuting(ResultExecutingContext).)
Public method ToString (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke (Inherited from Attribute.)
Top

Output caching lets you store the output of an action method in memory on the Web server. For example, if the action method renders a view, the view page will be cached. This cached page is then available to the application for subsequent requests. Output caching saves your application the time and resources it would take to re-create the result of the action method.

In ASP.NET MVC, you can use the OutputCacheAttribute attribute to mark action methods whose output you want to cache. If you mark a controller with the OutputCacheAttribute attribute, the output of all action methods in the controller will be cached.

The properties contained in OutputCacheAttribute are almost the same as the properties of the @ OutputCache directive. The only @ OutputCache property that is not supported by OutputCacheAttribute is VaryByControl.

Using a Cache Profile

To avoid code duplication, you can set a cache profile in the Web.config file instead of setting cache values individually in pages. You can then reference the profile by using the CacheProfile property of the OutputCache attribute. The following example shows a section of a Web.config file that sets a cache profile. This cache profile will apply to all pages unless the page overrides these settings.

<system.web>
  <caching>
    <outputCacheSettings>
      <outputCacheProfiles>
        <add name="MyProfile" duration="60" varyByParam="*" />
      </outputCacheProfiles>
    </outputCacheSettings>
  </caching>
</system.web>

The following example shows how to use OutputCacheAttribute to control output caching for the About action method. The attribute sets the cache duration to one minute. Minor changes to the About action method and the About view enable you to see when the view was most recently cached.

If you repeatedly click the tab for the About view, you can see that the page stays cached for 10 seconds, because the OutputCache attribute changed the duration that was set in the Web.config file.

The following example shows the About action method.


[OutputCache(CacheProfile = "MyProfile", Duration = 10)]
public ActionResult About()
{
    ViewData["Message"] = "This page was cached at " + DateTime.Now;

    return View();
}


The following example shows the About view.


<asp:Content ID="aboutTitle" ContentPlaceHolderID="TitleContent" runat="server">
    About Us
</asp:Content>

<asp:Content ID="aboutContent" ContentPlaceHolderID="MainContent" runat="server">
    <h2>About</h2>
    <p>
        <%= Html.Encode(ViewData["Message"]) %>
    </p>
</asp:Content>


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)