This documentation is archived and is not being maintained.

PageAdapter.CacheVaryByParams Property

Gets a list of additional parameters from HTTP GET and POST requests by which caching is varied for the Web page to which this derived page adapter is attached.

Namespace: System.Web.UI.Adapters
Assembly: System.Web (in system.web.dll)

public virtual StringCollection CacheVaryByParams { get; }
/** @property */
public StringCollection get_CacheVaryByParams ()

public function get CacheVaryByParams () : StringCollection

Not applicable.

Property Value

An IList that contains a list of the GET and POST parameters; otherwise, a null reference (Nothing in Visual Basic).

Entities on the Web that cache Web pages cache multiple versions based on, among other factors, the request parameters. For example, a version for each store location within a retail chain for which a page might be generated would typically be cached based on the parameter name (for example, StoreID).

For specific browsers, it might be necessary to vary caching by GET or POST parameters in addition to the parameters that control target-independent caching. For example, it might be necessary to cache different versions of a page for different mobile phone service providers.

Notes to Inheritors: When you inherit from the PageAdapter class, you can override the CacheVaryByParams property to return a list of the additional GET or POST parameters to control target-specific caching. The CacheVaryByParams base method returns a null reference (Nothing in Visual Basic).

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: