OutputCacheAttribute Class
Represents an attribute that is used to mark an action method whose output will be cached.
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)
The OutputCacheAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
 | AllowMultiple | Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified. (Inherited from FilterAttribute.) |
| CacheProfile | Gets or sets the cache profile name. |
| ChildActionCache | Gets or sets the child action cache. |
| Duration | Gets or sets the cache duration, in seconds. |
| Location | Gets or sets the location. |
| NoStore | Gets or sets a value that indicates whether to store the cache. |
| Order | Gets or sets the order in which the action filters are executed. (Inherited from FilterAttribute.) |
| SqlDependency | Gets or sets the SQL dependency. |
| TypeId | (Inherited from Attribute.) |
| VaryByContentEncoding | Gets or sets the vary-by-content encoding. |
| VaryByCustom | Gets or sets the vary-by-custom value. |
| VaryByHeader | Gets or sets the vary-by-header value. |
| VaryByParam | Gets or sets the vary-by-param value. |
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Attribute.) |
| Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Attribute.) |
| GetType | (Inherited from Object.) |
| IsChildActionCacheActive | Returns a value that indicates whether a child action cache is active. |
| IsDefaultAttribute | (Inherited from Attribute.) |
| Match | (Inherited from Attribute.) |
| MemberwiseClone | (Inherited from Object.) |
| 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).) |
| 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).) |
| 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. |
| 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).) |
| OnResultExecuting | Called before the action result executes. (Overrides ActionFilterAttribute.OnResultExecuting(ResultExecutingContext).) |
| ToString | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
| _Attribute.GetIDsOfNames | (Inherited from Attribute.) |
| _Attribute.GetTypeInfo | (Inherited from Attribute.) |
| _Attribute.GetTypeInfoCount | (Inherited from Attribute.) |
| _Attribute.Invoke | (Inherited from Attribute.) |
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.
The following example shows the About view.
