Class CachedSection

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

Cached section context handler.

[Obsolete("Class was not intended for public use and will be removed. Use interface IProgressiveCache instead.")]
[ObsoleteSince(29, 3)]
public abstract class CachedSection : Trackable<CachedSection>

Inheritance

object

DisposableObject

Trackable<CachedSection>

CachedSection

Derived

CachedSection<TData>

Inherited Members

Trackable<CachedSection>.TypeName

Trackable<CachedSection>.Track

Trackable<CachedSection>.TrackAllOpen(string)

DisposableObject.CallOnDispose(Action)

DisposableObject.Using(IDisposable)

DisposableObject.Dispose()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CachedSection(CacheSettings)

Constructor

protected CachedSection(CacheSettings settings)

Parameters

settings CacheSettings

Cache settings

Fields

mDataWasSet

Flag indicating whether the data property was set. The data property must be set if progressive caching is enabled

protected bool mDataWasSet

Field Value

bool

mException

Exception that occurred when loading data

protected Exception mException

Field Value

Exception

mLoadData

True if the data should be loaded by the code.

protected bool mLoadData

Field Value

bool

mLock

Object for the synchronization.

protected LockObject mLock

Field Value

LockObject

mLockAcquired

Flag whether the lock was acquired for this cached section

protected bool mLockAcquired

Field Value

bool

mRemoved

Flag set when the item is removed from the cache

protected bool mRemoved

Field Value

bool

mSettings

Cache settings

protected CacheSettings mSettings

Field Value

CacheSettings

Properties

BoolCondition

Cache condition.

public bool BoolCondition { get; set; }

Property Value

bool

CacheDependency

Cache dependency.

public CMSCacheDependency CacheDependency { get; set; }

Property Value

CMSCacheDependency

CacheItemName

Cache item name used for the caching.

public string CacheItemName { get; }

Property Value

string

CacheMinutes

Cache minutes.

public double CacheMinutes { get; set; }

Property Value

double

Cached

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

public bool Cached { get; set; }

Property Value

bool

Exception

Exception that occurred within loading of the data

public Exception Exception { get; set; }

Property Value

Exception

LoadData

If true, the external code should load the data. Using this property to control does not support distribution of unhandled exceptions in case of progressive caching.

public bool LoadData { get; }

Property Value

bool

Settings

Cache settings

public CacheSettings Settings { get; protected set; }

Property Value

CacheSettings

Methods

LogDataError()

Logs the error when data was not set

protected void LogDataError()

Remove()

Removes the cache item

public void Remove()