OutputCacheProfile OutputCacheProfile OutputCacheProfile OutputCacheProfile Class

Definition

Configures the output cache profile that can be used by the application pages. This class cannot be inherited.

public ref class OutputCacheProfile sealed : System::Configuration::ConfigurationElement
public sealed class OutputCacheProfile : System.Configuration.ConfigurationElement
type OutputCacheProfile = class
    inherit ConfigurationElement
Public NotInheritable Class OutputCacheProfile
Inherits ConfigurationElement
Inheritance
OutputCacheProfileOutputCacheProfileOutputCacheProfileOutputCacheProfile

Examples

The following code example shows how to use the OutputCacheProfiles collection to access its OutputCacheProfile objects.

  // Get the Web application configuration.
  System.Configuration.Configuration webConfig =
  WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

 // Get the section.

  string configPath = 
      "system.web/caching/outputCacheSettings";
  System.Web.Configuration.OutputCacheSettingsSection outputCacheSettings =
  (System.Web.Configuration.OutputCacheSettingsSection)webConfig.GetSection(
  configPath);

// Get the profile at zero index.
System.Web.Configuration.OutputCacheProfile outputCacheProfile = 
  outputCacheSettings.OutputCacheProfiles[0];


  ' Get the Web application configuration.
  Dim webConfig _
  As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

  ' Get the section.
  Dim configPath As String = _
 "system.web/caching/outputCacheSettings"
  Dim outputCacheSettings _
  As System.Web.Configuration.OutputCacheSettingsSection = _
  CType(webConfig.GetSection(configPath), _
  System.Web.Configuration.OutputCacheSettingsSection)

' Get the profile at zero index.
  Dim outputCacheProfile _
  As System.Web.Configuration.OutputCacheProfile = _
  outputCacheSettings.OutputCacheProfiles(0)

Remarks

The OutputCacheProfile class provides a way to programmatically access and modify the add element of the outputCacheProfiles section in the caching section of a configuration file.

The OutputCacheProfile object centralizes frequently used configuration settings such as dependencies, cache location, and cache expiration time, eliminating the need to specify them on every page.

The OutputCacheProfile can be applied to a page using the CacheProfile attribute of the directive.

Note

The directive can override all the settings contained by an OutputCacheProfile object except for the Enabled attribute. This is to enable or disable the OutputCacheProfile without having to modify the directives in all the pages that might have overridden it.

The CacheDependency class monitors the dependencies so that when any cached item changes, the cached item will be automatically removed.

Constructors

OutputCacheProfile(String) OutputCacheProfile(String) OutputCacheProfile(String) OutputCacheProfile(String)

Initializes a new instance of the OutputCacheProfile class.

Properties

CurrentConfiguration CurrentConfiguration CurrentConfiguration CurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Inherited from ConfigurationElement)
Duration Duration Duration Duration

Gets or sets the time duration during which the page or control is cached.

ElementInformation ElementInformation ElementInformation ElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Inherited from ConfigurationElement)
ElementProperty ElementProperty ElementProperty ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
Enabled Enabled Enabled Enabled

Gets or sets a value indicating whether caching is enabled.

EvaluationContext EvaluationContext EvaluationContext EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext HasContext HasContext HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String] Item[String] Item[String] Item[String]

Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
Location Location Location Location

Gets or sets the output cache location.

LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes LockAttributes LockAttributes LockAttributes

Gets the collection of locked attributes

(Inherited from ConfigurationElement)
LockElements LockElements LockElements LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem LockItem LockItem LockItem

Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
Name Name Name Name

Gets or sets the OutputCacheProfile name.

NoStore NoStore NoStore NoStore

Gets or sets a value indicating whether secondary storage is enabled.

Properties Properties Properties Properties

Gets the collection of properties.

(Inherited from ConfigurationElement)
SqlDependency SqlDependency SqlDependency SqlDependency

Gets or sets the SqlDependency property.

VaryByContentEncoding VaryByContentEncoding VaryByContentEncoding VaryByContentEncoding

Gets or sets the semicolon-delimited set of content encodings to be cached.

VaryByControl VaryByControl VaryByControl VaryByControl

Gets or sets the VaryByControl property.

VaryByCustom VaryByCustom VaryByCustom VaryByCustom

Gets or sets the VaryByCustom property.

VaryByHeader VaryByHeader VaryByHeader VaryByHeader

Gets or sets the VaryByHeader property.

VaryByParam VaryByParam VaryByParam VaryByParam

Gets or sets the VaryByParam property.

Methods

DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init() Init() Init() Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault() InitializeDefault() InitializeDefault() InitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
IsModified() IsModified() IsModified() IsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.

(Inherited from ConfigurationElement)
IsReadOnly() IsReadOnly() IsReadOnly() IsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList) ListErrors(IList) ListErrors(IList) ListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize() PostDeserialize() PostDeserialize() PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Inherited from ConfigurationElement)
ResetModified() ResetModified() ResetModified() ResetModified()

Resets the value of the IsModified() method to false when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly() SetReadOnly() SetReadOnly() SetReadOnly()

Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Inherited from ConfigurationElement)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

Applies to

See also