Click or drag to resize
CachedSectionTData Class
Cached section context handler.
Inheritance Hierarchy
SystemObject
  CMS.BaseDisposableObject
    CMS.HelpersTrackableCachedSection
      CMS.HelpersCachedSection
        CMS.HelpersCachedSectionTData

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 12.0.0
Syntax
C#
public class CachedSection<TData> : CachedSection

Type Parameters

TData

The CachedSectionTData type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmData
Data to be cached / retrieved
Protected fieldmDataWasSet
Flag indicating whether the data property was set. The data property must be set if progressive caching is enabled
(Inherited from CachedSection.)
Protected fieldmException
Exception that occurred when loading data
(Inherited from CachedSection.)
Protected fieldmLoadData
True if the data should be loaded by the code.
(Inherited from CachedSection.)
Protected fieldmLock
Object for the synchronization.
(Inherited from CachedSection.)
Protected fieldmLockAcquired
Flag whether the lock was acquired for this cached section
(Inherited from CachedSection.)
Protected fieldmRemoved
Flag set when the item is removed from the cache
(Inherited from CachedSection.)
Protected fieldmSettings
Cache settings
(Inherited from CachedSection.)
Top
Properties
  NameDescription
Public propertyBoolCondition
Cache condition.
(Inherited from CachedSection.)
Public propertyCached
If true, the data is used from the cache if available / cached
(Inherited from CachedSection.)
Public propertyCacheDependency
Cache dependency.
(Inherited from CachedSection.)
Public propertyCacheItemName
Cache item name used for the caching.
(Inherited from CachedSection.)
Public propertyCacheMinutes
Cache minutes.
(Inherited from CachedSection.)
Public propertyData
Data to be cached / retrieved
Public propertyException
Exception that occurred within loading of the data
(Inherited from CachedSection.)
Public propertyLoadData
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 propertySettings
Cache settings
(Inherited from CachedSection.)
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodDispose
Disposes the object.
(Overrides DisposableObjectDispose.)
Public methodGetData
Attempts to get the data from cache.
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Protected methodLogDataError
Logs the error when data was not set
(Inherited from CachedSection.)
Public methodRemove
Removes the cache item
(Inherited from CachedSection.)
Public methodUsing
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.)
Top
See Also