CacheSettings Class

Cache settings container.

Inheritance Hierarchy

System.Object
  CMS.Helpers.CacheSettings

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public class CacheSettings

The CacheSettings type exposes the following members.

Constructors

	Name	Description
Public method	CacheSettings(Double, Object[])	Initializes a new instance of the CacheSettings with absolute expiration.
Public method	CacheSettings(Double, Boolean, Object[])	Initializes a new instance of the CacheSettings.

Properties

	Name	Description
Public property	AllowProgressiveCaching	If true, progressive caching is enabled, meaning that two threads accessing the same code share the result of an internal operation.
Public property	BoolCondition	Cache condition.
Public property	Cached	If true, the data is used from the cache if available / cached.
Public property	CacheDependency	Cache dependency to use for the cache item. When GetCacheDependency is set and this property is not set explicitly, the value is retrieved by calling the delegate in GetCacheDependency property. Use setter of this property only in the data loading code of the cached code block to avoid unnecessary initialization of the dependencies. Use delegate property GetCacheDependency to provide cache dependencies in a more efficient way only when the system really needs them.
Public property	CacheItemName	Cache item name used for the caching.
Public property	CacheItemNameParts	Cache item name parts (form the cache item name if the custom item name is not available).
Public property	CacheItemPriority	Cache priority.
Public property	CacheMinutes	Cache minutes.
Public property	CustomCacheItemName	Custom cache item name (if set, used instead of the parts).
Public property	GetCacheDependency	Function to dynamically get the cache dependency.
Public property	UseSlidingExpiration	Indicates whether sliding expiration should be used. If enabled, objects are removed from the cache only if they are not accessed for the number of minutes specified by CacheMinutes.