TransformationHelper Class

Base transformation class.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<TransformationHelper>
        CMS.DocumentEngine.Web.UI.TransformationHelper

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131

Syntax

public class TransformationHelper : AbstractHelper<TransformationHelper>

The TransformationHelper type exposes the following members.

Constructors

	Name	Description
Public method	TransformationHelper

Properties

	Name	Description
Public property Static member	HTMLEncodeEval	Gets or sets whether Eval() methods in CMSAbstractTransformation class encodes string values.

Methods

	Name	Description
Public method	EnsureValueHTMLEncode<ReturnType>	Returns HTML encoded value if value is string and it should be encoded(it depends on value of CMSHTMLEncodeEval key in configuration file).
Public method	FormatDateTime	Format date time.
Public method	GetAbsoluteUrl(String)	Obsolete. Returns absolute URL from relative path.
Public method	GetAbsoluteUrl(String, SiteInfoIdentifier)	Obsolete. Returns absolute URL from relative path.
Public method	GetAttachmentUrl	Obsolete. Returns URL of the attachment.
Public method	GetAttachmentUrlByDocumentId	Obsolete. Returns URL of the attachment.
Public method	GetAttachmentUrlByGUID	Returns URL of the attachment.
Public method	GetDateTime	Returns date time with dependence on current ITimeZone manager time zone settings.
Public method	GetDateTimeString	Returns string representation of date time with dependence on current ITimeZone manager time zone settings.
Public method	GetFileIconClass	Obsolete. Returns font icon class for specified file extension.
Public method	GetSearchedContent	Returns content parsed as XML if required and removes dynamic controls.
Public method	GetSearchImageUrl	Returns URL to given search result item.
Public method	GetSearchValue	Returns column value for current search result item.
Public method	GetSharePointFileUrl	Gets URL for accessing file on SharePoint server.
Public method	HTMLEncode	Returns encoded text.
Public method	If	Obsolete. If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned.
Public method	IfCompare	Obsolete. Transformation "if" statement for guid, int, string, double, decimal, boolean, DateTime The type of compare depends on comparable value (second parameter) If both values are NULL, method returns false result.
Public method	IfDataSourceIsEmpty	Obsolete. Returns nonEmptyResult if specified data source is null or empty, else returns emptyResult.
Public method	IfEmpty	Obsolete. Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public method	IfImage	Obsolete. Returns isImage value if file is image.
Public method Static member	LoadTransformation	Loads the transformation template. Supports the following formats of transformation name: [Some text with macros] - Inline transformation cms.user.sometransformation - Transformation full name from database ~/SomePath/SomeControl.ascx - Path to transformation user control
Public method Static member	LoadTransformationFromPath	Loads the transformation from the given path
Public method	SearchHighlight	Highlight input text with dependence on current search keywords.
Public method	SearchResultUrl	Returns URL for given search result.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)