Class CacheSettings

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

Cache settings container.

public class CacheSettings

Inheritance

object

CacheSettings

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CacheSettings(double, bool, params object[])

Initializes a new instance of the CacheSettings.

public CacheSettings(double cacheMinutes, bool useSlidingExpiration, params object[] cacheItemNameParts)

Parameters

cacheMinutes double

Cache minutes.

useSlidingExpiration bool

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.

cacheItemNameParts object[]

Cache item name parts (form the cache item name if the custom item name is not available).

CacheSettings(double, params object[])

Initializes a new instance of the CacheSettings with absolute expiration.

public CacheSettings(double cacheMinutes, params object[] cacheItemNameParts)

Parameters

cacheMinutes double

Cache minutes.

cacheItemNameParts object[]

Cache item name parts (form the cache item name if the custom item name is not available).

Properties

AllowProgressiveCaching

If true, progressive caching is enabled, meaning that two threads accessing the same code share the result of an internal operation.

public bool AllowProgressiveCaching { get; set; }

Property Value

bool

BoolCondition

Cache condition.

public bool BoolCondition { get; set; }

Property Value

bool

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 CMSCacheDependency CacheDependency { get; set; }

Property Value

CMSCacheDependency

CacheItemName

Cache item name used for the caching.

public string CacheItemName { get; }

Property Value

string

CacheItemNameParts

Cache item name parts (form the cache item name if the custom item name is not available).

public IEnumerable CacheItemNameParts { get; set; }

Property Value

IEnumerable

CacheItemPriority

Cache priority.

public CMSCacheItemPriority CacheItemPriority { get; set; }

Property Value

CMSCacheItemPriority

CacheMinutes

Cache minutes.

public double CacheMinutes { get; set; }

Property Value

double

Remarks

Value is used as absolute or sliding expiration time based on UseSlidingExpiration value.

Cached

If true, the data is used from the cache if available / cached.

public bool Cached { get; set; }

Property Value

bool

CustomCacheItemName

Custom cache item name (if set, used instead of the parts).

public string CustomCacheItemName { get; set; }

Property Value

string

GetCacheDependency

Function to dynamically get the cache dependency.

public Func<CMSCacheDependency> GetCacheDependency { get; set; }

Property Value

Func<CMSCacheDependency>

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.

public bool UseSlidingExpiration { get; }

Property Value

bool