The CacheHelper type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | CacheHelper |
Methods
| Name | Description | |
|---|---|---|
 | Add(String, Object, CMSCacheDependency, DateTime, TimeSpan) |
Mirror to Cache.Add().
|
| Add(String, Object, CMSCacheDependency, DateTime, TimeSpan, CacheItemPriority, CacheItemRemovedCallback, Boolean) |
Mirror to Cache.Add().
|
| AddOutputCacheDependencies |
Adds the given keys as a dependency for current page output.
|
| AddPersistent DataType |
Saves the persistent item to the file
|
| AddResponseCacheDependencies |
Adds the given dependency cache keys to the Response cache.
|
| BuildCacheItemName |
Builds the cache item name from the given parts
|
| Cache TData (Func TData , CacheSettings) |
Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
|
| Cache TData (Func CacheSettings, TData , CacheSettings) |
Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
|
| CacheEnabled |
Returns true if the content caching is enabled.
|
| CacheImageAllowed |
Checks if the file attachment is below the maximum file size used for caching.
|
| CacheImageEnabled |
Returns true if the image caching is enabled.
|
| CacheImageMinutes |
Cache image minutes.
|
| CacheMinutes |
Cache content minutes.
|
| CachePageInfoEnabled |
Returns true if the page info caching is enabled.
|
| CachePageInfoMinutes |
Cache page info minutes.
|
| ClearCache |
Clears the entire system cache.
|
| ClearCache(String, Boolean, Boolean) |
Clears the cache content starting with given string
|
| ClearCSSCache |
Clear the CSS cache
|
| ClearFileNodeCache |
Clear the cache for the file document nodes.
|
| ClearFullPageCache |
Clear the full page cache (output cache) of the pages.
|
| ClearOutputCache |
Clears the output cache for specific page.
|
| ClearPageInfoCache |
Clear the page info cache.
|
| ClearPartialCache |
Clear the partial cache (output cache) of the controls.
|
| ClearURLRewritingCache |
Clears the cache of the URL rewriting.
|
| ClientCacheMinutes |
Client cache minutes for the processed content (both files and pages).
|
 | CreateCacheDependencyInternal |
Creates the cache dependency with specified parameters
|
| DeletePersistent |
Restores the persistent item from the cache
|
| DeletePersistentInternal |
Restores the persistent item from the cache
|
| EnsureDummyKey |
Ensures the dummy key with the given name
|
| EnsureKey |
Ensures the specified cache key.
|
| EnsureOutputCacheDependencies |
Ensures the dependency list for the given key, so the dependencies for current page output can be tracked. The dependencies are tracked automatically only when TrackCacheDependencies property is enabled.
|
|  Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBaseCacheKey |
Returns the base cache key (created with all parameters considered to be valid for proper caching).
|
| GetCacheDependencies |
Processes the dependencies string and returns default dependencies if the source is null or NO_CACHE_DEPENDENCY constant.
|
| GetCacheDependency(List String ) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(String) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency( String ) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(List String , List String ) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency( String , String ) |
Creates the cache dependency from the given keys.
|
| GetCacheItemName(String, Object ) |
Gets the cache item string.
|
| GetCacheItemName(Boolean, String, Object ) |
Gets the cache item string.
|
| GetCacheItemsString |
Gets the cache items string (item names separated by semicolon)
|
| GetCombinedCacheItems |
Gets combined cache items for setting and default items
|
| GetCultureCacheKey |
Gets the cache key for current culture
|
| GetCultureCacheKey(String) |
Gets the cache key for the given culture
|
| GetDependencyCacheKeys |
Parses the string and returns the array of the cache dependency keys.
|
| GetEnumeratorInternal |
Gets the enumerator for the cache items.
|
| GetFileCacheDependency |
Creates the cache dependency from the given file path.
|
| GetFromPersistentFileInternal DataType |
Gets the persistent item from file
|
| GetFullKeyInternal |
Gets the full cache key with the prefix
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetInnerValue |
Gets the inner value for the cache item
|
| GetInternal |
Gets the item from the cache.
|
| GetItem |
Gets item from cache.
|
| GetPersistentFileName |
Gets the persistent file name for the given cache key
|
| GetPersistentFilePathInternal |
Gets the file name for the given cache key
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| GetUserCacheKey |
Gets the cache key for current user
|
| GetUserCacheKey(String) |
Gets the cache key for current user the given user
|
| InsertInternal |
Inserts the item into the cache.
|
| MaxCacheFileSize |
Maximum size of the file that is allowed to be cached in kilobytes.
|
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| RegisterAutomaticCallback |
Registers the automatic callback that is executed at the specific time
|
| RegisterDependencyCallback TTarget |
Registers a cache callback for given list of cache dependencies
|
| Remove |
Removes object from cache.
|
| RemoveDependencyCallback |
Registers a cache callback for given list of cache dependencies
|
| RemoveInternal |
Removes the item from the cache.
|
| RevalidateClientCache |
Returns whether the client cache should be revalidated by the call to the server.
|
| SaveToPersistentFileInternal DataType |
Saves the persistent item to the file
|
| SetAsDefaultHelper |
Sets this object as the default helper
(Inherited from AbstractHelper HelperType .) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TouchKey(String) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean, DateTime) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean, DateTime, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKeys(IEnumerable String ) |
Touches the cache key to drop the dependencies.
|
| TouchKeys(IEnumerable String , Boolean, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKeys(String, Boolean, Boolean) |
Touches the cache keys separated by new line to drop the dependencies.
|
| TryGetItem(String, Object ) |
Returns true if the cache contains the item with specified key.
|
| TryGetItem(String, Boolean, Object ) |
Returns true if the cache contains the item with specified key.
|
| TryGetItem OutputType (String, OutputType ) |
Returns true if the cache contains the item with specified key.
|
| TryGetItem OutputType (String, Boolean, OutputType , Boolean) |
Returns true if the cache contains the item with specified key.
|
| TryRestorePersistent DataType |
Restores the persistent item from the cache
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | CacheItemPriority |
Cache item priority.
|
| CSS_KEY |
CSS caching key.
|
| DEFAULT_CACHE_DEPENDENCIES |
Default cache dependencies constant.
|
| DUMMY_KEY |
Dummy item.
|
| FILENODE_KEY |
File node caching key.
|
| FULLPAGE_KEY |
Full page caching key.
|
 | mProgressiveCaching |
If true, progressive caching is enabled, meaning that two threads accessing the same code share the result of an internal operation
|
| NO_CACHE_DEPENDENCIES |
No cache dependencies constant.
|
| PAGEINFO_KEY |
Page info caching key.
|
| PARTIAL_KEY |
Partial cache key.
|
| SEPARATOR |
Cache item separator.
|
| URLREWRITING_KEY |
URL Rewriting cache key.
|
Properties
| Name | Description | |
|---|---|---|
 | AllowCacheByCulture |
If true, the cache allows separate keys by culture.
|
| AllowCacheByUserName |
If true, the cache allows separate keys by user name.
|
| AlwaysCacheFiles |
Gets if files are always cached on client, even outside the live site.
|
| AlwaysCacheResources |
Gets if resources are always cached on client, even outside the live site.
|
| ApplicationTerminating | Obsolete.
Returns true if the application is terminating
|
| BaseCacheKey |
Returns the base cache key (created with all parameters considered to be valid for proper caching).
|
| CacheURLRewritingMinutes |
Cache URL rewriting minutes.
|
| ClientCacheRequested |
Gets if the client specified cache settings in request.
|
| CurrentCachePrefix |
Current context name
|
| CurrentRequestDependencyList |
Current request dependency list, if set the list is used for the cache dependencies of the page output.
|
| DependencyChanged |
DependencyChanged items count (removed by the dependency).
|
| Expired |
Expired items count (removed by the system for expiration reasons).
|
| MultiplePrefixesUsed |
If true, multiple cache prefixes were used
|
| PersistentDirectory |
Persistent data directory.
|
| PhysicalFilesCacheMinutes |
Gets the expiration time in minutes that should be set for the physical files in the client cache.
|
| ProgressiveCaching |
If true, progressive caching is enabled, meaning that two threads accessing the same code share the result of an internal operation
|
| Removed |
Removed items count (removed correctly by the system).
|
| TrackCacheDependencies |
Returns true if the cache dependencies for the output cache are tracked.
|
| Underused |
Underused items count (removed sooner for memory reasons).
|
See Also