outputCacheSettings Element for caching (ASP.NET Settings Schema)

  • Article

Specifies the output-cache profile settings that can be applied to pages in an ASP.NET application.

<outputCacheSettings>
    <outputCacheProfiles>...</outputCacheProfiles>
</outputCacheSettings>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child Elements

Element Description

outputCacheProfiles

Contains groups of cache settings that can be applied to pages to specify the OutputCache directive.

Parent Elements

Element Description

configuration

The required root element in every configuration file used by the common language runtime and .NET Framework applications.

system.web

Specifies the root element for the ASP.NET configuration settings in a configuration file. Contains configuration elements that configure ASP.NET Web applications and control how the applications behave.

caching

Configures the cache settings for a Web application.

Remarks

Default Configuration

The following default outputCacheSettings element is not explicitly configured in the machine configuration file or in the root Web.config file, but is the default configuration returned by an application in the .NET Framework version 2.0.

<outputCacheSettings>
  <outputCacheProfiles>
    <add name = "" 
      enabled = "true" 
      duration = "-1" 
      location = "" 
      sqlDependency = "" 
      varyByCustom = "" 
      varyByControl = "" 
      varyByHeader = "" 
      varyByParam = "" 
      noStore = "false"/>
  </outputCacheProfiles>
</outputCacheSettings>
<outputCacheSettings>
  <outputCacheProfiles>
    <clear />
  </outputCacheProfiles>
</outputCacheSettings>

Example

The following example caches a page on the server for only one minute and stores different versions of the page based on browser type and major version.

<outputCacheSettings>
  <outputCacheProfiles>
    <add name="ServerOnly" 
      duration="60" 
      varyByCustom="browser” 
      location="Server" />
  </outputCacheProfiles>
</outputCacheSettings>

When designing a page that needs to be cached in this way, you will need to add the following directive to the page:

<%@ OutputCache CacheProfile="ServerOnly" %>

For more information, see @ OutputCache.

Element Information

Configuration Section Handler

System.Web.Configuration.OutputCacheSettingsSection

Configuration Member

System.Web.Configuration.SystemWebCachingSectionGroup.OutputCacheSettings

Configurable Locations

Machine.config

Root level Web.config

Application level Web.config

Requirements

IIS 5.0, 5.1 and 6.0

.NET Framework 2.0

Visual Studio 2005

See Also

Tasks

How to: Configure Specific Directories Using Location Settings
How to: Lock ASP.NET Configuration Settings

Reference

system.web Element (ASP.NET Settings Schema)
configuration Element (General Settings Schema)
caching Element (ASP.NET Settings Schema)
outputCacheProfiles Element for outputCacheSettings for caching (ASP.NET Settings Schema)
System.Configuration
System.Web.Configuration

Concepts

ASP.NET Caching Overview
How-to Topics — ASP.NET Caching (Visual Studio)
ASP.NET Configuration File Hierarchy and Inheritance
Securing ASP.NET Configuration
ASP.NET Configuration Scenarios

Other Resources

Getting Started - Enhancing Web Site Performance with Caching
Learning More - About Enhancing Web Site Performance with Caching
General Configuration Settings (ASP.NET)
ASP.NET Configuration Settings
Configuring ASP.NET Applications
ASP.NET Configuration Files
ASP.NET Configuration API