OutputCacheAttribute Class
TOC
Collapse the table of content
Expand the table of content

OutputCacheAttribute Class

 

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

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

NameDescription
System_CAPS_pubmethodOutputCacheAttribute()

Initializes a new instance of the OutputCacheAttribute class.

NameDescription
System_CAPS_pubpropertyAllowMultiple

Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified.(Inherited from FilterAttribute.)

System_CAPS_pubpropertyCacheProfile

Gets or sets the cache profile name.

System_CAPS_pubpropertySystem_CAPS_staticChildActionCache

Gets or sets the child action cache.

System_CAPS_pubpropertyDuration

Gets or sets the cache duration, in seconds.

System_CAPS_pubpropertyLocation

Gets or sets the location.

System_CAPS_pubpropertyNoStore

Gets or sets a value that indicates whether to store the cache.

System_CAPS_pubpropertyOrder

Gets or sets the order in which the action filters are executed.(Inherited from FilterAttribute.)

System_CAPS_pubpropertySqlDependency

Gets or sets the SQL dependency.

System_CAPS_pubpropertyTypeId

(Inherited from Attribute.)

System_CAPS_pubpropertyVaryByContentEncoding

Gets or sets the vary-by-content encoding.

System_CAPS_pubpropertyVaryByCustom

Gets or sets the vary-by-custom value.

System_CAPS_pubpropertyVaryByHeader

Gets or sets the vary-by-header value.

System_CAPS_pubpropertyVaryByParam

Gets or sets the vary-by-param value.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticIsChildActionCacheActive(ControllerContext)

Returns a value that indicates whether a child action cache is active.

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnActionExecuted(ActionExecutedContext)

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).)

System_CAPS_pubmethodOnActionExecuting(ActionExecutingContext)

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).)

System_CAPS_pubmethodOnException(ExceptionContext)

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.

System_CAPS_pubmethodOnResultExecuted(ResultExecutedContext)

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).)

System_CAPS_pubmethodOnResultExecuting(ResultExecutingContext)

Called before the action result executes.(Overrides ActionFilterAttribute.OnResultExecuting(ResultExecutingContext).)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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>

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft