CMSAbstractTransformation Class

Base transformation class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.DocumentEngine.Web.UI.CMSAbstractTransformation
            CMS.DocumentEngine.Web.UI.CMSErrorTransformation

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

Syntax

public class CMSAbstractTransformation : AbstractUserControl, 
	IDataItemContainer, INamingContainer, IRelatedData

The CMSAbstractTransformation type exposes the following members.

Constructors

	Name	Description
Public method	CMSAbstractTransformation

Fields

	Name	Description
Protected field Static member	mCDATARegExp	Regular expression for CDATA.
Protected field	mDataControl	Parent data control.
Protected field	mDataControlSearched	Returns true if the parent data control was already searched
Protected field	mDocumentCustomData	Document custom data.
Protected field	mEditableItems	Editable items (document content).
Protected field	mNodeCustomData	Node custom data.
Protected field	mObject	Object containing the data
Protected field	mObjectLoaded	Flag whether the object was loaded or not
Protected field	mRelatedData	Custom data connected to the object.
Protected field	mRelatedDataLoaded	Related data is loaded.
Protected field	mTrackEvals	If true, the evals are tracked within this transformation

Properties

	Name	Description
Public property Static member	CDATARegExp	URL regular expression.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DataControl	Parent data control.
Public property	DataItem	Gets the data item object for current binding context.
Public property	DataItemCount	Gets the number of data items for the current binding context.
Public property	DataItemIndex	Gets the data item index for current transformation container You have to use Container.DataItemIndex for index in current binding context
Public property	DataRowView	Returns current data row view.
Public property	DisplayIndex	Gets the display index for current transformation container You have to use Container.DisplayIndex for display index in current binding context
Public property	DocumentCustomData	Document custom data.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditableItems	Editable items (document content).
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property Static member	Methods	Methods provided by the transformation
Public property	NodeCustomData	Node custom data.
Public property	Object	Object with the data
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddCurrentCategoryParameter	Appends current category ID to given URL.
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	DataBind	Data bind. (Overrides Control.DataBind().)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	EnsureMaximumLineLength	Limits line length of the given plain text.
Protected method	EnsureObject	Ensures the internal transformation object which provides the nested data
Public method	Eval(String)	Evaluates the item data (safe version). (Overrides AbstractUserControl.Eval(String).)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	Eval<ReturnType>(String)	Templated Eval, returns the value converted to specific type. (Overrides AbstractUserControl.Eval(String).)
Public method	EvalBool	Evaluates the item data and converts it to the boolean. (Overrides AbstractUserControl.EvalBool(String).)
Public method	EvalCDATA(String)	Evaluates the item data and return escaped CDATA.
Public method	EvalCDATA(String, Boolean)	Evaluates the item data and return escaped CDATA.
Protected method	EvalColumnInternal	Evaluates the data column
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Overrides AbstractUserControl.EvalDateTime(String).)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Overrides AbstractUserControl.EvalDecimal(String).)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Overrides AbstractUserControl.EvalDouble(String).)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Overrides AbstractUserControl.EvalGuid(String).)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Overrides AbstractUserControl.EvalHTML(String).)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Overrides AbstractUserControl.EvalInteger(String).)
Protected method	EvalInternal	Evaluates the expression on the available data
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Overrides AbstractUserControl.EvalJSString(String).)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string non-html content. (Overrides AbstractUserControl.EvalText(String).)
Public method	EvalText(String, Boolean)	Evaluates the item data, encodes it and optionally localizes it. Method should be used for columns with string non-html content. (Overrides AbstractUserControl.EvalText(String, Boolean).)
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 attachment icon.
Public method	GetAttachmentUrl	Returns friendly URL of the attachment.
Public method	GetAttachmentUrlByDocumentId	Returns friendly URL of the attachment.
Public method	GetAttachmentUrlByGUID	Returns URL of the attachment based on given GUID.
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	GetColumnName(String)	Returns first column which is present and not empty.
Public method	GetColumnName(String, Boolean)	Returns first column which is present.
Public method	GetCustomDateTime	Returns date time with dependence on selected time zone.
Public method	GetDataControlValue(String)	Gets the Data control value.
Public method	GetDataControlValue<ReturnType>(String)	Gets the Data control value.
Public method	GetDate	Returns date from the provided date-time value.
Public method	GetDateTime(DateTime)	Returns date time with dependence on current ITimeZone manager time zone settings.
Public method	GetDateTime(Object)	Returns date time with dependence on current ITimeZone manager time zone settings.
Public method	GetDateTime(String)	Returns date and time string.
Public method	GetDateTime(String, String)	Returns date and time in given format.
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	GetDocumentLink(Boolean)	Returns a complete HTML code of the link to the currently rendered document.
Public method	GetDocumentUrl()	Returns URL of the currently rendered document.
Public method	GetDocumentUrl(Object)	Obsolete. Returns URL of the given document.
Public method	GetDocumentUrl(Object, Object)	Obsolete. Returns URL of the given document (for use with document selector).
Public method	GetDocumentUrlByGUID	Returns URL of the given document.
Public method	GetDocumentUrlById	Returns URL of the given 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	GetEditableValue	Gets the editable control value.
Public method	GetEventDateString	Returns string representation of event time.
Protected method	GetFeedName	Returns safe feed name. Checks "FeedName" and "InstanceGUID" columns in data controls.
Public method	GetFileIcon	Returns HTML markup representing file icon.
Public method	GetFileIconClass	Returns font icon class for specified file extension.
Public method	GetFileUrl(Object, Object, String)	Obsolete. Returns URL of the attachment.
Public method	GetFileUrl(Object, String, String)	Obsolete. Returns URL of the attachment stored in the given column name.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
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(Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined.
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	GetGroupProfileUrl(Object)	Returns group profile URL.
Public method	GetGroupProfileUrl(Object, String)	Returns group profile URL.
Public method	GetImage(Object, Int32)	Returns a complete HTML code of the image that is specified in the given column.
Public method	GetImage(Object, Int32, Int32)	Returns a complete HTML code of the image that is specified in the given column.
Public method	GetImage(Object, Object, Object, Object, Object)	Returns a complete HTML code of the image that is specified in the given column.
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	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
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	GetNotEmpty	Returns first nonEmpty column.
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 current 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	GetSharePointImageUrl	Gets URL for accessing an image 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	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetUIImageUrl(String)	Gets UI image resolved path.
Public method	GetUIImageUrl(String, Boolean)	Gets UI image resolved path.
Public method	GetUIImageUrl(String, Boolean, Boolean)	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(Int32, String)	Returns user avatar image. Datarow must contains 'AvatarGuid' and 'UserGender' columns.
Public method	GetUserAvatarImage(Object, Object, Int32, Object)	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserAvatarImage(Object, Int32, Int32, Int32, Object)	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserAvatarImage(Object, Object, Int32, Int32, Int32, Object)	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 image URL, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserAvatarImageUrl(Object, Object, String, Int32, Int32, Int32)	Returns avatar image URL, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method	GetUserDateTime	Returns current user date time DateTime according to user time zone.
Public method Static member	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	IfEmpty	Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public method	IfImage	Returns isImage value if file is image.
Public method	IfTrue	If input value is evaluated as True then 'true result' is returned, otherwise empty string is returned.
Public method	IsCurrentDocument	Indicates if the document is current document.
Public method	IsDocumentOnSelectedPath	Indicates if the document is on selected path.
Public method	IsFirst	Indicates if current data item is the first.
Public method	IsImageDocument	Indicates if the document is image.
Public method	IsLast	Indicates it current data item is the last.
Public method	LimitLength(Object, Int32)	Limits length of the given plain text.
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	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	Localize	Returns localized text.
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RemoveDiscussionMacros	Remove all types of discussion macros from text.
Public method	RemoveDynamicControls	Remove all dynamic controls macros from text.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
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	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SearchHighlight	Highlight input text with dependence on current search keywords.
Public method	SearchResultUrl	Returns URL for current search result.
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	StripTags	Remove HTML tags from text.
Public method	TrimSitePrefix	Trims the site prefix from user name(if any prefix found)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)