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: 12.0.0

Syntax

public class TransformationHelper : AbstractHelper<TransformationHelper>

The TransformationHelper type exposes the following members.

Constructors

	Name	Description
Public method	TransformationHelper

Fields

	Name	Description
Protected field Static member	mCDATARegExp	Regular expression for CDATA.

Properties

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

Methods

	Name	Description
Public method	AddCurrentCategoryParameter	Appends current category ID to given url.
Public method	EnsureMaximumLineLength	Limits line length of the given plain text.
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	EvalCDATA(Object)	Escapes CDATA value.
Public method	EvalCDATA(Object, Boolean)	Escapes CDATA value.
Public method	FormatDate	Format date without time part.
Public method	FormatDateTime	Format date time.
Public method	GetAbsoluteUrl(String)	Returns absolute URL from relative path.
Public method	GetAbsoluteUrl(String, SiteInfoIdentifier)	Returns absolute URL from relative path.
Public method	GetAge	Returns age according to DOB. If DOB is not set, returns unknownAge string.
Public method	GetAtomDateTime	Gets time according to RFC 3339 for Atom feeds.
Public method	GetAttachmentIcon	Returns HTML markup representing icon.
Public method	GetAttachmentUrl	Returns URL of the attachment.
Public method	GetAttachmentUrlByDocumentId	Returns URL of the attachment.
Public method	GetAttachmentUrlByGUID	Returns URL of the attachment.
Public method	GetBadgeImage	Returns badge image tag.
Public method	GetBadgeName	Returns badge name.
Public method	GetBlogCommentUrl	Returns URL of the blog comment document.
Public method	GetBlogCommentUrlForFeed	Returns URL of the blog comment document with feed parameter.
Public method	GetCountryDisplayName	Returns country displayname based on its codename.
Public method	GetCurrentDateTimeString	Returns date time string according to user or current site time zone.
Public method	GetCustomDateTime	Returns date time with dependence on selected time zone.
Public method	GetDate	Returns date from the provided date-time value.
Public method	GetDateTime(Control, DateTime)	Returns date time with dependence on current ITimeZone manager time zone settings.
Public method	GetDateTime(Control, Object)	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	GetDocumentCssClass	Gets document CSS class comparing the current document node alias path.
Public method	GetDocumentLink	Returns a complete HTML code of the link to the currently rendered document.
Public method	GetDocumentUrl(Object)	Returns URL of the given document.
Public method	GetDocumentUrl(Object, Object)	Returns URL of the given document (for use with document selector).
Public method	GetDocumentUrl(Object, Object, Object, String)	Returns URL of the currently rendered document.
Public method	GetDocumentUrlForFeed	Returns URL of the currently rendered document with feed parameter.
Public method	GetEditableImage	Returns a complete HTML code of the image that is specified by editable image ID.
Public method	GetEditableImageUrl	Gets the editable image value.
Public method	GetEventDateString	Returns string representation of event time with dependence on current ITimeZone manager time zone settings.
Public method	GetFeedName	Returns feed name. If feed name is defined, than returns it. Otherwise returns instance GUID.
Public method	GetFileIcon	Returns HTML markup representing icon.
Public method	GetFileIconClass	Returns font icon class for specified file extension.
Public method	GetForumPostUrl	Returns URL of the specified forum post.
Public method	GetForumPostUrlForFeed	Returns URL of the specified forum post with feed parameter.
Public method	GetGender	Returns gender of the user.
Public method	GetGroupAvatarImage(Object, Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public method	GetGroupAvatarImage(Object, Int32, Int32, Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public method	GetGroupAvatarImageByGUID	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public method	GetGroupProfileUrl(Object)	Returns group profile URL.
Public method	GetGroupProfileUrl(Object, String)	Returns group profile URL.
Public method	GetImage(Object, Object, Int32)	Returns a complete HTML code of the image.
Public method	GetImage(Object, Object, Int32, Int32)	Returns a complete HTML code of the image.
Public method	GetImage(Object, Object, Object, Object, Object, Object)	Returns a complete HTML code of the image.
Public method	GetImageByUrl(Object, Int32)	Returns a complete HTML code of the image that is specified by the given url.
Public method	GetImageByUrl(Object, Int32, Int32)	Returns a complete HTML code of the image that is specified by the given url.
Public method	GetImageByUrl(Object, Object, Object, Object, Object)	Returns a complete HTML code of the image that is specified by the given url.
Public method	GetMediaFileUrl	Returns URL of the specified media file.
Public method	GetMediaFileUrlForFeed	Returns URL of the specified media file with feed parameter.
Public method	GetMemberProfileUrl(Object)	Returns member profile URL.
Public method	GetMemberProfileUrl(Object, String)	Returns member profile URL.
Public method	GetMessageBoardUrl	Returns URL of the message board document.
Public method	GetMessageBoardUrlForFeed	Returns URL of the message board document with feed parameter.
Public method	GetMetaFileUrl	Returns URL of the specified meta file.
Public method	GetNavigationUrl	Returns resolved (i.e. absolute) URL of data item (page) that currently being processed. Method reflects page navigation settings.
Public method	GetRSSDateTime	Gets time according to RFC 822 for RSS feeds.
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	GetSiteDateTime	Returns site date time according to site time zone.
Public method	GetSitemapItem	Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority).
Public method	GetUIImageUrl(String, Page)	Gets UI image resolved path.
Public method	GetUIImageUrl(String, Boolean, Page)	Gets UI image resolved path.
Public method	GetUIImageUrl(String, Boolean, Boolean, Page)	Gets UI image path.
Public method	GetUrl(Object, Object)	Returns URL for the specified aliasPath and urlPath (preferable).
Public method	GetUrl(Object, Object, Object)	Returns URL for the specified aliasPath and urlPath (preferable).
Public method	GetUserAvatarImage	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserAvatarImageByGUID	Returns user avatar image.
Public method	GetUserAvatarImageForUser	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserAvatarImageUrl(Object, Object, Int32, Int32, Int32)	Returns avatar or gravatar image url, if it is not defined returns gender dependent avatar or user default avatar.
Public method	GetUserAvatarImageUrl(Object, Object, Object, Int32, Int32, Int32)	Returns avatar or gravatar image url, if it is not defined returns gender dependent avatar or user default avatar.
Public method	GetUserDateTime	Returns current user date time DateTime according to user time zone.
Public method	GetUserFullName	Returns user full name.
Public method	GetUserProfileURL(Object)	Returns user profile URL.
Public method	GetUserProfileURL(Object, String)	Returns user profile URL.
Public method	HTMLEncode	Returns encoded text.
Public method	If	If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned.
Public method	IfCompare	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	Returns nonEmptyResult if specified data source is null or empty, else returns emptyResult.
Public method	IfEmpty	Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public method	IfImage	Returns isImage value if file is image.
Public method	IsCurrentDocument	Indicates if the document is current document.
Public method	IsDocumentOnSelectedPath	Indicates if the document is on selected path.
Public method	IsImageDocument	Indicates if the document is image.
Public method	JSEncode	Encodes input string to be used in javascript code and encapsulates it with "'".
Public method	LimitLength(Object, Int32, String)	Limits length of the given plain text.
Public method	LimitLength(Object, Int32, String, Boolean)	Limits length of the given plain text.
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	RemoveDiscussionMacros	Remove all types of discussion macros from text.
Public method	RemoveDynamicControls	Remove all dynamic controls macros from text.
Public method	ResolveCurrentPath	Resolves the given alias path, applies the path segment to the given format string {0} for level 0.
Public method	ResolveDiscussionMacros	Resolves the discussion macros.
Public method	ResolveMacros	Resolves the macros in the given text
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>.)
Public method	StripTags	Remove HTML tags from text.
Public method	TrimSitePrefix	Trims the site prefix from user name(if any prefix found)