This documentation is archived and is not being maintained.

OutputCacheParameters Class

Encapsulates the output cache initialization settings parsed from an @ OutputCache page directive by ASP.NET. This class cannot be inherited.


Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)

public sealed class OutputCacheParameters

The OutputCacheParameters type exposes the following members.

Public methodOutputCacheParametersInitializes a new instance of the OutputCacheParameters class.

Public propertyCacheProfileGets or sets an OutputCacheProfile name that is associated with the settings of the output cache entry.
Public propertyDurationGets or sets the amount of time that a cache entry is to remain in the output cache.
Public propertyEnabledGets or sets a value indicating whether output caching is enabled for the current content.
Public propertyLocationGets or sets a value that determines the location of the cache entry.
Public propertyNoStoreGets or sets a value that determines whether the HTTP Cache-Control: no-store directive is set.
Public propertySqlDependencyGets or sets a set of database and table name pairs that the cache entry depends on.
Public propertyVaryByContentEncodingGets or sets a comma-delimited set of character sets (content encodings) used to vary the cache entry.
Public propertyVaryByControlGets or sets a semicolon-delimited set of control identifiers contained within the current page or user control used to vary the current cache entry.
Public propertyVaryByCustomGets a list of custom strings that the output cache uses to vary the cache entry.
Public propertyVaryByHeaderGets or sets a comma-delimited set of header names used to vary the cache entry. The header names identify HTTP headers associated with the request.
Public propertyVaryByParamGets a semicolon-delimited list of query string or form POST parameters that the output cache uses to vary the cache entry.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The OutputCacheParameters class is not used by ASP.NET page or control developers. It provides a data structure used to store cache settings parsed from an @ OutputCache page directive by ASP.NET page and control parsers such as PageParser and TemplateControlParser. The OutputCacheParameters object is used with the PageInitOutputCache(OutputCacheSettings) method to initialize the output cache for a page and its contents at run time.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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