OutputHelper Class

Output helper.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<OutputHelper>
        CMS.OutputFilter.OutputHelper

Namespace: CMS.OutputFilter
Assembly: CMS.OutputFilter (in CMS.OutputFilter.dll) Version: 8.2.23

Syntax

public class OutputHelper : AbstractHelper<OutputHelper>

The OutputHelper type exposes the following members.

Constructors

	Name	Description
Public method	OutputHelper

Methods

	Name	Description
Public method Static member	AddNoClientCacheParameter	Adds the parameter to disable client cache to the URLs of the page HTML code. Applies only on URLs with querystring or .aspx pages, except for .axd requests.
Public method Static member	AddNoClientCacheParameters	Adds the parameter to disable client cache to the URLs of the page HTML code.
Public method Static member	AddToCache	Adds the item to the cache
Protected method	AddToCacheInternal	Adds the item to the cache
Public method Static member	EnableOutputCache	Returns true if the output caching is enabled.
Public method Static member	EndRequest	Ends the current request
Public method Static member	FileSystemOutputCacheMinutes	Returns the number of minutes for which the output cache should be stored in the file system
Public method Static member	GetContextCacheString	Gets the context cache string for the given set of items.
Public method Static member	GetOutputCacheKey	Gets the output cache key for the request.
Protected method	GetOutputCacheKeyInternal	Gets the output cache key for the request.
Public method Static member	GetVaryByCustomString	Custom cache parameters processing.
Public method Static member	SaveOutputToCache	Saves the output data to the cache.
Protected method	SaveOutputToCacheInternal	Saves the output data to the cache.
Public method Static member	SendOutputFromCache	Sends the page output from the output cache.
Protected method	SendOutputFromCacheInternal	Sends the page output from the output cache.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	SetCaching	Sets the page caching.
Public method Static member	TryGetFromCache	Attempts to get the cached output from the cache. Returns true if output was found in cache. Otherwise false.
Protected method	TryGetFromCacheInternal	Attempts to get the cached output from the cache. Returns true if output was found in cache. Otherwise false.

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
Public field Static member	CacheItemPriority	Cache item priority.

Properties

	Name	Description
Public property Static member	AvailableCacheItemNames	Gets list of cache items supported by system
Public property Static member	CacheItems	List of the cache key items separated by semicolon. Defaults to "username;sitename;lang;browser;cookielevel;deviceprofile". Other available values are: domain, viewmode
Public property Static member	ClearOutputCacheOnPostback	If true, output cache is cleared on postback.
Public property Static member	UseOutputFilterCache	Returns true if full client cache is enabled (no revalidation requests).