CachedSection 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: 8.2.23

Syntax

public abstract class CachedSection : Trackable<CachedSection>

The CachedSection type exposes the following members.

Constructors

	Name	Description
Protected method	CachedSection	Constructor

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	Make sure the objects get disposed (Inherited from DisposableObject.)
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
Public method	Remove	Removes the cache item
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

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

Properties

	Name	Description
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.
Public property	CacheItemName	Cache item name used for the caching.
Public property	CacheMinutes	Cache minutes.
Public property	Exception	Exception that occurred within loading of the data
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.
Public property	Settings	Cache settings