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