Click or drag to resize
TransformationHelper Class
Base transformation class.
Inheritance Hierarchy
SystemObject
  CMS.BaseCoreMethods
    CMS.BaseAbstractHelper
      CMS.BaseAbstractHelperTransformationHelper
        CMS.DocumentEngine.Web.UITransformationHelper

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class TransformationHelper : AbstractHelper<TransformationHelper>

The TransformationHelper type exposes the following members.

Constructors
  NameDescription
Public methodTransformationHelper
Top
Fields
  NameDescription
Protected fieldStatic membermCDATARegExp
Regular expression for CDATA.
Top
Properties
  NameDescription
Public propertyStatic memberCDATARegExp
URL regular expression.
Public propertyStatic memberHTMLEncodeEval
Gets or sets whether Eval() methods in CMSAbstractTransformation class encodes string values.
Top
Methods
  NameDescription
Public methodAddCurrentCategoryParameter
Appends current category ID to given url.
Public methodEnsureMaximumLineLength
Limits line length of the given plain text.
Public methodEnsureValueHTMLEncodeReturnType
Returns HTML encoded value if value is string and it should be encoded(it depends on value of CMSHTMLEncodeEval key in configuration file).
Public methodEvalCDATA(Object)
Escapes CDATA value.
Public methodEvalCDATA(Object, Boolean)
Escapes CDATA value.
Public methodFormatDate
Format date without time part.
Public methodFormatDateTime
Format date time.
Public methodGetAbsoluteUrl(String)
Returns absolute URL from relative path.
Public methodGetAbsoluteUrl(String, SiteInfoIdentifier)
Returns absolute URL from relative path.
Public methodGetAge
Returns age according to DOB. If DOB is not set, returns unknownAge string.
Public methodGetAtomDateTime
Gets time according to RFC 3339 for Atom feeds.
Public methodGetAttachmentIcon
Returns HTML markup representing icon.
Public methodGetAttachmentUrl
Returns URL of the attachment.
Public methodGetAttachmentUrlByDocumentId
Returns URL of the attachment.
Public methodGetAttachmentUrlByGUID
Returns URL of the attachment.
Public methodGetBadgeImage
Returns badge image tag.
Public methodGetBadgeName
Returns badge name.
Public methodGetBlogCommentUrl
Returns URL of the blog comment document.
Public methodGetBlogCommentUrlForFeed
Returns URL of the blog comment document with feed parameter.
Public methodGetCountryDisplayName
Returns country displayname based on its codename.
Public methodGetCurrentDateTimeString
Returns date time string according to user or current site time zone.
Public methodGetCustomDateTime
Returns date time with dependence on selected time zone.
Public methodGetDate
Returns date from the provided date-time value.
Public methodGetDateTime(Control, DateTime)
Returns date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDateTime(Control, Object)
Returns date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDateTimeString
Returns string representation of date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDocumentCssClass
Gets document CSS class comparing the current document node alias path.
Public methodGetDocumentLink
Returns a complete HTML code of the link to the currently rendered document.
Public methodGetDocumentUrl(Object)
Returns URL of the given document.
Public methodGetDocumentUrl(Object, Object)
Returns URL of the given document (for use with document selector).
Public methodGetDocumentUrl(Object, Object, Object, String)
Returns URL of the currently rendered document.
Public methodGetDocumentUrlForFeed
Returns URL of the currently rendered document with feed parameter.
Public methodGetEditableImage
Returns a complete HTML code of the image that is specified by editable image ID.
Public methodGetEditableImageUrl
Gets the editable image value.
Public methodGetEventDateString
Returns string representation of event time with dependence on current ITimeZone manager time zone settings.
Public methodGetFeedName
Returns feed name. If feed name is defined, than returns it. Otherwise returns instance GUID.
Public methodGetFileIcon
Returns HTML markup representing icon.
Public methodGetFileIconClass
Returns font icon class for specified file extension.
Public methodGetForumPostUrl
Returns URL of the specified forum post.
Public methodGetForumPostUrlForFeed
Returns URL of the specified forum post with feed parameter.
Public methodGetGender
Returns gender of the user.
Public methodGetGroupAvatarImage(Object, Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupAvatarImage(Object, Int32, Int32, Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupAvatarImageByGUID
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupProfileUrl(Object)
Returns group profile URL.
Public methodGetGroupProfileUrl(Object, String)
Returns group profile URL.
Public methodGetImage(Object, Object, Int32)
Returns a complete HTML code of the image.
Public methodGetImage(Object, Object, Int32, Int32)
Returns a complete HTML code of the image.
Public methodGetImage(Object, Object, Object, Object, Object, Object)
Returns a complete HTML code of the image.
Public methodGetImageByUrl(Object, Int32)
Returns a complete HTML code of the image that is specified by the given url.
Public methodGetImageByUrl(Object, Int32, Int32)
Returns a complete HTML code of the image that is specified by the given url.
Public methodGetImageByUrl(Object, Object, Object, Object, Object)
Returns a complete HTML code of the image that is specified by the given url.
Public methodGetMediaFileUrl
Returns URL of the specified media file.
Public methodGetMediaFileUrlForFeed
Returns URL of the specified media file with feed parameter.
Public methodGetMemberProfileUrl(Object)
Returns member profile URL.
Public methodGetMemberProfileUrl(Object, String)
Returns member profile URL.
Public methodGetMessageBoardUrl
Returns URL of the message board document.
Public methodGetMessageBoardUrlForFeed
Returns URL of the message board document with feed parameter.
Public methodGetMetaFileUrl
Returns URL of the specified meta file.
Public methodGetNavigationUrl
Returns resolved (i.e. absolute) URL of data item (page) that currently being processed. Method reflects page navigation settings.
Public methodGetRSSDateTime
Gets time according to RFC 822 for RSS feeds.
Public methodGetSearchedContent
Returns content parsed as XML if required and removes dynamic controls.
Public methodGetSearchImageUrl
Returns URL to given search result item.
Public methodGetSearchValue
Returns column value for current search result item.
Public methodGetSharePointFileUrl
Gets URL for accessing file on SharePoint server.
Public methodGetSiteDateTime
Returns site date time according to site time zone.
Public methodGetSitemapItem
Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority).
Public methodGetUIImageUrl(String, Page)
Gets UI image resolved path.
Public methodGetUIImageUrl(String, Boolean, Page)
Gets UI image resolved path.
Public methodGetUIImageUrl(String, Boolean, Boolean, Page)
Gets UI image path.
Public methodGetUrl(Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
Public methodGetUrl(Object, Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
Public methodGetUserAvatarImage
Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public methodGetUserAvatarImageByGUID
Returns user avatar image.
Public methodGetUserAvatarImageForUser
Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public methodGetUserAvatarImageUrl(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 methodGetUserAvatarImageUrl(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 methodGetUserDateTime
Returns current user date time DateTime according to user time zone.
Public methodGetUserFullName
Returns user full name.
Public methodGetUserProfileURL(Object)
Returns user profile URL.
Public methodGetUserProfileURL(Object, String)
Returns user profile URL.
Public methodHTMLEncode
Returns encoded text.
Public methodIf
If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned.
Public methodIfCompare
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 methodIfDataSourceIsEmpty
Returns nonEmptyResult if specified data source is null or empty, else returns emptyResult.
Public methodIfEmpty
Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public methodIfImage
Returns isImage value if file is image.
Public methodIsCurrentDocument
Indicates if the document is current document.
Public methodIsDocumentOnSelectedPath
Indicates if the document is on selected path.
Public methodIsImageDocument
Indicates if the document is image.
Public methodJSEncode
Encodes input string to be used in javascript code and encapsulates it with "'".
Public methodLimitLength(Object, Int32, String)
Limits length of the given plain text.
Public methodLimitLength(Object, Int32, String, Boolean)
Limits length of the given plain text.
Public methodStatic memberLoadTransformation
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 methodStatic memberLoadTransformationFromPath
Loads the transformation from the given path
Public methodRemoveDiscussionMacros
Remove all types of discussion macros from text.
Public methodRemoveDynamicControls
Remove all dynamic controls macros from text.
Public methodResolveCurrentPath
Resolves the given alias path, applies the path segment to the given format string {0} for level 0.
Public methodResolveDiscussionMacros
Resolves the discussion macros.
Public methodResolveMacros
Resolves the macros in the given text
Public methodSearchHighlight
Highlight input text with dependence on current search keywords.
Public methodSearchResultUrl
Returns URL for given search result.
Public methodSetAsDefaultHelper
Sets this object as the default helper
(Inherited from AbstractHelperHelperType.)
Public methodStripTags
Remove HTML tags from text.
Public methodTrimSitePrefix
Trims the site prefix from user name(if any prefix found)
Top
See Also