CachedSection<TData> Class

Cached section context handler.

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.Helpers.Trackable<CachedSection>
      CMS.Helpers.CachedSection
        CMS.Helpers.CachedSection<TData>

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

Syntax

public class CachedSection<TData> : CachedSection

Type Parameters

TData

The CachedSection<TData> type exposes the following members.

Constructors

	Name	Description
Public method	CachedSection<TData>(TData, CacheSettings)	Constructor.
Public method	CachedSection<TData>(TData, Double, Boolean, String, Object[])	Constructor.

Fields

	Name	Description
Protected field	mData	Data to be cached / retrieved
Protected field	mDataWasSet	Flag indicating whether the data property was set. The data property must be set if progressive caching is enabled (Inherited from CachedSection.)
Protected field	mException	Exception that occurred when loading data (Inherited from CachedSection.)
Protected field	mLoadData	True if the data should be loaded by the code. (Inherited from CachedSection.)
Protected field	mLock	Object for the synchronization. (Inherited from CachedSection.)
Protected field	mLockAcquired	Flag whether the lock was acquired for this cached section (Inherited from CachedSection.)
Protected field	mRemoved	Flag set when the item is removed from the cache (Inherited from CachedSection.)
Protected field	mSettings	Cache settings (Inherited from CachedSection.)

Properties

	Name	Description
Public property	BoolCondition	Cache condition. (Inherited from CachedSection.)
Public property	Cached	If true, the data is used from the cache if available / cached (Inherited from CachedSection.)
Public property	CacheDependency	Cache dependency. (Inherited from CachedSection.)
Public property	CacheItemName	Cache item name used for the caching. (Inherited from CachedSection.)
Public property	CacheMinutes	Cache minutes. (Inherited from CachedSection.)
Public property	Data	Data to be cached / retrieved
Public property	Exception	Exception that occurred within loading of the data (Inherited from CachedSection.)
Public property	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. (Inherited from CachedSection.)
Public property	Settings	Cache settings (Inherited from CachedSection.)

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Dispose	Disposes the object. (Overrides DisposableObject.Dispose().)
Public method	GetData	Attempts to get the data from cache.
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
Protected method	LogDataError	Logs the error when data was not set (Inherited from CachedSection.)
Public method	Remove	Removes the cache item (Inherited from CachedSection.)
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)