TransformationMethods Class

Class containing wrapper methods for transformation methods which can be used in macro resolver.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtensionContainer<MacroMethodContainer, MacroMethod>
    CMS.MacroEngine.MacroMethodContainer
      CMS.Controls.TransformationMethods

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

Syntax

public class TransformationMethods : MacroMethodContainer

The TransformationMethods type exposes the following members.

Constructors

	Name	Description
Public method	TransformationMethods

Methods

	Name	Description
Public method Static member	AddCurrentCategoryParameter	Appends current category ID to given url.
Public method Static member	EnsureMaximumLineLength	Limits line length of the given plain text.
Public method Static member	Eval	Evaluates the item data and returns it.
Public method Static member	EvalCDATA	Evaluates the item data and return escaped CDATA.
Public method Static member	FormatDate	Format date without time part.
Public method Static member	FormatDateTime	Format date time.
Public method Static member	GetAbsoluteUrl	Returns absolute URL from relative path.
Public method Static member	GetAbsoluteUrlBySiteID	Returns absolute URL from relative path.
Public method Static member	GetAbsoluteUrlBySiteName	Returns absolute URL from relative path.
Public method Static member	GetAge	Returns age according to DOB. If DOB is not set, returns unknownAge string.
Public method Static member	GetAtomDateTime	Gets time according to RFC 3339 for Atom feeds.
Public method Static member	GetAttachmentIcon	Returns HTML markup representing attachment icon.
Public method Static member	GetAttachmentUrl	Returns URL of the attachment.
Public method Static member	GetBadgeImage	Returns badge image tag.
Public method Static member	GetBadgeName	Returns badge name.
Public method Static member	GetBlogCommentUrl	Returns URL of the blog comment document.
Public method Static member	GetBlogCommentUrlForFeed	Returns URL of the blog comment page with feed parameter.
Public method Static member	GetCountryDisplayName	Returns country displayname based on its codename.
Public method Static member	GetCurrentDateTimeString	Returns date time string according to user or current site time zone.
Public method Static member	GetCustomDateTime	Returns date time with dependence on selected time zone.
Public method Static member	GetDate	Returns date from the provided date-time value.
Public method Static member	GetDateTime	Returns date time with dependence on current ITimeZone manager time zone settings.
Public method Static member	GetDateTimeString	Returns string representation of date time with dependence on current ITimeZone manager time zone settings.
Public method Static member	GetDocumentCssClass	Gets page CSS class comparing the current page alias path. Returns selectedCssClass if given alias path matches the current page alias path. Otherwise returns cssClass.
Public method Static member	GetDocumentLink	Returns a complete HTML code of the link to the currently rendered page.
Public method Static member	GetDocumentUrl	Returns URL of specified document.
Public method Static member	GetDocumentUrlByGUID	Returns URL of specified page.
Public method Static member	GetDocumentUrlByID	Returns URL of specified document.
Public method Static member	GetDocumentUrlForFeed	Returns URL of the currently rendered document with feed parameter.
Public method Static member	GetEditableImage	Returns a complete HTML code of the image that is specified by editable image content.
Public method Static member	GetEditableImageUrl	Gets the editable image value.
Protected method	GetExtension(String)	Returns a Extension of given name (return null if specified Extension does not exist). (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	GetExtension(Type, String)	Returns the extension by type and name. Does not cache the result. Does not cache the result. (Inherited from MacroMethodContainer.)
Protected method	GetExtensions	Gets the extensions for the given type. Does not cache the result. (Inherited from MacroMethodContainer.)
Public method Static member	GetFileIcon	Returns HTML markup representing file icon.
Public method Static member	GetFileUrl	Returns URL of the attachment with given name.
Public method Static member	GetFileUrlByGUID	Returns URL of the attachment with given attachment GUID.
Public method Static member	GetFileUrlFromAlias	Returns URL of the attachment with given GUID.
Public method Static member	GetForumPostUrl	Returns URL of the specified forum post.
Public method Static member	GetForumPostUrlForFeed	Returns URL of the specified forum post with feed parameter.
Public method Static member	GetGender	Returns gender of the user.
Public method Static member	GetGroupAvatarImage	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public method Static member	GetGroupAvatarImageByGUID	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public method Static member	GetGroupProfileUrl	Returns group profile URL.
Public method Static member	GetImage	Returns a complete HTML code of the image that is specified by node alias and attachment GUID.
Public method Static member	GetImageByUrl	Returns a complete HTML code of the image that is specified by the given url.
Public method Static member	GetImageUrl	Gets UI image resolved path.
Public method Static member	GetMediaFileUrlForFeed	Returns URL of the specified media file with feed parameter.
Public method Static member	GetMemberProfileUrl	Returns member profile URL.
Public method Static member	GetMessageBoardUrl	Returns URL of the message board document.
Public method Static member	GetMessageBoardUrlForFeed	Returns URL of the message board page with feed parameter.
Public method	GetMethod	Returns a method of given name (return null if specified method does not exist). (Inherited from MacroMethodContainer.)
Public method Static member	GetRSSDateTime	Gets time according to RFC 822 for RSS feeds.
Public method Static member	GetSearchedContent	Returns content parsed as XML if required and removes dynamic controls.
Public method Static member	GetSearchImageUrl	Returns URL to current search result item.
Public method Static member	GetSearchValue	Returns column value for current search result item.
Public method Static member	GetSiteDateTime	Returns site date time according to site time zone.
Public method Static member	GetSitemapItem	Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority).
Public method Static member	GetUIImageUrl	Gets UI image resolved path.
Public method Static member	GetUrl	Returns URL for the specified aliasPath and urlPath (preferable).
Public method Static member	GetUserAvatarImage	Returns user avatar image.
Public method Static member	GetUserAvatarImageByGUID	Returns user avatar image.
Public method Static member	GetUserAvatarImageForUser	Returns user avatar image.
Public method Static member	GetUserAvatarImageUrl	Returns user avatar image URL.
Public method Static member	GetUserDateTime	Returns current user date time DateTime according to user time zone.
Public method Static member	GetUserFullName	Returns user full name.
Public method Static member	GetUserProfileURL	Returns user profile URL.
Public method Static member	HTMLEncode	Returns encoded text.
Public method Static member	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.
Public method Static member	IfDataSourceIsEmpty	Returns nonEmptyResult if specified data source is null or empty, else returns emptyResult.
Public method Static member	IfEmpty	Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public method Static member	IfImage	Returns isImage value if file is image.
Public method Static member	IsCurrentDocument	Indicates if the given page is the current page.
Public method Static member	IsDocumentOnSelectedPath	Indicates if the page is on selected path.
Public method Static member	IsImageDocument	Indicates if the page is an image.
Public method Static member	JSEncode	Evaluates the item data and returns it.
Protected method	RegisterExtension	Registers a Extension to the container. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	RegisterExtensions	Registers all the methods. (Inherited from MacroMethodContainer.)
Public method	RegisterMethod	Registers the given method. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethodInternal(String, Func<EvaluationContext, Object[], Object>, Type, String, Int32, Object[,], String[])	Registers the given method within the method table. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethodInternal(String[], Func<EvaluationContext, Object[], Object>, Type, String, Int32, Object[,], String[])	Registers the given method within the method table. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethods()	Registers all the methods. (Inherited from MacroMethodContainer.)
Public method	RegisterMethods(MacroMethod[])	Registers the given methods. (Inherited from MacroMethodContainer.)
Public method Static member	RemoveDiscussionMacros	Remove all oc of discussion macros from text.
Public method Static member	RemoveDynamicControls	Remove all dynamic controls macros from text.
Public method Static member	SearchHighlight	Highlight input text with dependence on current search keywords.
Public method Static member	SearchResultUrl	Returns URL for current search result.
Public method Static member	TrimSitePrefix	Trims the site prefix from user name(if any prefix found)

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.)

Properties

	Name	Description
Protected property	Extensions	Extensions dictionary (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensionNames	Returns enumerable of all registered Extension names. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensions	Returns enumerable of all Extensions. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Public property	RegisteredMethods	Returns enumerable of all methods. (Inherited from MacroMethodContainer.)