Share via

add Element for outputCacheProfiles for caching (ASP.NET Settings Schema)

  • Article

Adds an OutputCacheProfile object to the configuration collection. Cache profiles can only be referenced from the @ OutputCache directive for pages. Profiles are not supported on user controls or server controls.

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

<add name="String" 
     enabled="true|false" 
     duration="number" 
     location="Any|Client|Downstream|Server|None|ServerAndClient" 
     sqlDependency="String" 
     varyByCustom="String" 
     varyByControl="String" 
     varyByHeader="String" 
     varyByParam="String" 
     noStore="true|false" />

Attributes and Elements

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

Attributes

Attribute

Description

name

Required String attribute.

Sets the unique name of the cache profile.

enabled

Optional Boolean attribute.

Enables output cache for a profile.

duration

Optional TimeSpan attribute.

Sets the amount of time in seconds that a page is stored in the cache.

location

Optional Int32 attribute.

Determines where the cached response is allowed to be stored.

sqlDependency

Optional String attribute.

Sets the page-level SQL cache dependency.

varyByCustom

Optional String attribute.

Sets the string that is used when calling varyByCustom for the page.

varyByControl

Optional String attribute.

Sets the ID of the control to be cached and used when calling varyByControl. Can also be set to a semicolon delimited list of IDs.

varyByHeader

Optional String attribute.

Names a semicolon delimited set of headers used to vary the cached output.

varyByParam

Optional String attribute.

Names a semicolon delimited set of parameters used to vary the cached output.

noStore

Optional Boolean attribute.

Sets a value indicating whether the "Cache-Control: no-store" directive is sent in the response for cached pages.

Child Elements

None.

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.

outputCacheSettings

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

outputCacheProfiles

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

Remarks

Default Configuration

The following default add 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.

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

Example

The following example caches a page on the server only for 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

OutputCacheSettingsSection.OutputCacheProfiles

Configurable locations

Machine.config

Root level Web.config

Application level Web.config

Requirements

IIS version 5.0, 5.1 and 6.0

.NET Framework version 2.0

Visual Studio 2005

See Also

Tasks

Walkthrough: Using Output Caching to Enhance Web Site Performance

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)

outputCacheSettings Element for caching (ASP.NET Settings Schema)

outputCacheProfiles Element for outputCacheSettings for caching (ASP.NET Settings Schema)

System.Configuration

System.Web.Configuration

Concepts

ASP.NET Caching Overview

ASP.NET Configuration File Hierarchy and Inheritance

Securing ASP.NET Configuration

ASP.NET Configuration Scenarios

Other Resources

General Configuration Settings (ASP.NET)

ASP.NET Configuration Settings

ASP.NET Web Site Administration

ASP.NET Configuration Files

ASP.NET Configuration API