CMSErrorTransformation Class

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

Syntax

public class CMSErrorTransformation : CMSAbstractTransformation

The CMSErrorTransformation type exposes the following members.

Constructors

	Name	Description
Public method	CMSErrorTransformation

Fields

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

Properties

	Name	Description
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. (Inherited from CMSAbstractTransformation.)
Public property	DataItem	Gets the data item object for current binding context. (Inherited from CMSAbstractTransformation.)
Public property	DataItemCount	Gets the number of data items for the current binding context. (Inherited from CMSAbstractTransformation.)
Public property	DataItemIndex	Gets the data item index for current transformation container You have to use Container.DataItemIndex for index in current binding context (Inherited from CMSAbstractTransformation.)
Public property	DataRowView	Returns current data row view. (Inherited from CMSAbstractTransformation.)
Public property	DisplayIndex	Gets the display index for current transformation container You have to use Container.DisplayIndex for display index in current binding context (Inherited from CMSAbstractTransformation.)
Public property	DocumentCustomData	Document custom data. (Inherited from CMSAbstractTransformation.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditableItems	Editable items (document content). (Inherited from CMSAbstractTransformation.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	InnerException	Inner exception to display.
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	NodeCustomData	Node custom data. (Inherited from CMSAbstractTransformation.)
Public property	Object	Object with the data (Inherited from CMSAbstractTransformation.)
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
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.)
Protected method	CreateChildControls	Creates the child controls. (Overrides Control.CreateChildControls().)
Public method	DataBind	Data bind. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Protected method	EnsureObject	Ensures the internal transformation object which provides the nested data (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	EvalBool	Evaluates the item data and converts it to the boolean. (Inherited from CMSAbstractTransformation.)
Public method	EvalCDATA(String)	Evaluates the item data and return escaped CDATA. (Inherited from CMSAbstractTransformation.)
Public method	EvalCDATA(String, Boolean)	Evaluates the item data and return escaped CDATA. (Inherited from CMSAbstractTransformation.)
Protected method	EvalColumnInternal	Evaluates the data column (Inherited from CMSAbstractTransformation.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from CMSAbstractTransformation.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from CMSAbstractTransformation.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from CMSAbstractTransformation.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from CMSAbstractTransformation.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Protected method	EvalInternal	Evaluates the expression on the available data (Inherited from CMSAbstractTransformation.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from CMSAbstractTransformation.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string non-html content. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	FormatDate	Format date without time part. (Inherited from CMSAbstractTransformation.)
Public method	FormatDateTime	Format date time. (Inherited from CMSAbstractTransformation.)
Public method	GetAbsoluteUrl(String)	Returns absolute URL from relative path. (Inherited from CMSAbstractTransformation.)
Public method	GetAbsoluteUrl(String, SiteInfoIdentifier)	Returns absolute URL from relative path. (Inherited from CMSAbstractTransformation.)
Public method	GetAge	Returns age according to DOB. If DOB is not set, returns unknownAge string. (Inherited from CMSAbstractTransformation.)
Public method	GetAtomDateTime	Gets time according to RFC 3339 for Atom feeds. (Inherited from CMSAbstractTransformation.)
Public method	GetAttachmentIcon	Returns HTML markup representing attachment icon. (Inherited from CMSAbstractTransformation.)
Public method	GetAttachmentUrl	Returns friendly URL of the attachment. (Inherited from CMSAbstractTransformation.)
Public method	GetAttachmentUrlByDocumentId	Returns friendly URL of the attachment. (Inherited from CMSAbstractTransformation.)
Public method	GetAttachmentUrlByGUID	Returns URL of the attachment based on given GUID. (Inherited from CMSAbstractTransformation.)
Public method	GetBadgeImage	Returns badge image tag. (Inherited from CMSAbstractTransformation.)
Public method	GetBadgeName	Returns badge name. (Inherited from CMSAbstractTransformation.)
Public method	GetBlogCommentUrl	Returns URL of the blog comment document. (Inherited from CMSAbstractTransformation.)
Public method	GetBlogCommentUrlForFeed	Returns URL of the blog comment document with feed parameter. (Inherited from CMSAbstractTransformation.)
Public method	GetColumnName(String)	Returns first column which is present and not empty. (Inherited from CMSAbstractTransformation.)
Public method	GetColumnName(String, Boolean)	Returns first column which is present. (Inherited from CMSAbstractTransformation.)
Public method	GetCustomDateTime	Returns date time with dependence on selected time zone. (Inherited from CMSAbstractTransformation.)
Public method	GetDataControlValue(String)	Gets the Data control value. (Inherited from CMSAbstractTransformation.)
Public method	GetDate	Returns date from the provided date-time value. (Inherited from CMSAbstractTransformation.)
Public method	GetDateTime(DateTime)	Returns date time with dependence on current ITimeZone manager time zone settings. (Inherited from CMSAbstractTransformation.)
Public method	GetDateTime(Object)	Returns date time with dependence on current ITimeZone manager time zone settings. (Inherited from CMSAbstractTransformation.)
Public method	GetDateTime(String)	Returns date and time string. (Inherited from CMSAbstractTransformation.)
Public method	GetDateTime(String, String)	Returns date and time in given format. (Inherited from CMSAbstractTransformation.)
Public method	GetDateTimeString	Returns string representation of date time with dependence on current ITimeZone manager time zone settings. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentCssClass	Gets document CSS class comparing the current document node alias path. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentLink()	Returns a complete HTML code of the link to the currently rendered document. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentLink(Boolean)	Returns a complete HTML code of the link to the currently rendered document. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentUrl	Returns URL of the currently rendered document. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentUrlByGUID	Returns URL of the given document. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentUrlById	Returns URL of the given document. (Inherited from CMSAbstractTransformation.)
Public method	GetDocumentUrlForFeed	Returns URL of the currently rendered document with feed parameter. (Inherited from CMSAbstractTransformation.)
Public method	GetEditableImage	Returns a complete HTML code of the image that is specified by editable image ID. (Inherited from CMSAbstractTransformation.)
Public method	GetEditableImageUrl	Gets the editable image value. (Inherited from CMSAbstractTransformation.)
Public method	GetEditableValue	Gets the editable control value. (Inherited from CMSAbstractTransformation.)
Public method	GetEventDateString	Returns string representation of event time. (Inherited from CMSAbstractTransformation.)
Protected method	GetFeedName	Returns safe feed name. Checks "FeedName" and "InstanceGUID" columns in data controls. (Inherited from CMSAbstractTransformation.)
Public method	GetFileIcon	Returns HTML markup representing file icon. (Inherited from CMSAbstractTransformation.)
Public method	GetFileIconClass	Returns font icon class for specified file extension. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	GetForumPostUrlForFeed	Returns URL of the specified forum post with feed parameter. (Inherited from CMSAbstractTransformation.)
Public method	GetGender	Returns gender of the user. (Inherited from CMSAbstractTransformation.)
Public method	GetGroupAvatarImage(Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined. (Inherited from CMSAbstractTransformation.)
Public method	GetGroupAvatarImage(Object, Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined. (Inherited from CMSAbstractTransformation.)
Public method	GetGroupAvatarImage(Object, Int32, Int32, Int32, Object)	Returns group avatar image tag, if avatar is not defined returns default group if is defined. (Inherited from CMSAbstractTransformation.)
Public method	GetGroupProfileUrl(Object)	Returns group profile URL. (Inherited from CMSAbstractTransformation.)
Public method	GetGroupProfileUrl(Object, String)	Returns group profile URL. (Inherited from CMSAbstractTransformation.)
Public method	GetImage(Object, Int32)	Returns a complete HTML code of the image that is specified in the given column. (Inherited from CMSAbstractTransformation.)
Public method	GetImage(Object, Int32, Int32)	Returns a complete HTML code of the image that is specified in the given column. (Inherited from CMSAbstractTransformation.)
Public method	GetImage(Object, Object, Object, Object, Object)	Returns a complete HTML code of the image that is specified in the given column. (Inherited from CMSAbstractTransformation.)
Public method	GetImageByUrl(Object, Int32)	Returns a complete HTML code of the image that is specified by the given URL. (Inherited from CMSAbstractTransformation.)
Public method	GetImageByUrl(Object, Int32, Int32)	Returns a complete HTML code of the image that is specified by the given URL. (Inherited from CMSAbstractTransformation.)
Public method	GetImageByUrl(Object, Object, Object, Object, Object)	Returns a complete HTML code of the image that is specified by the given url. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	GetMediaFileUrlForFeed	Returns URL of the specified media file with feed parameter. (Inherited from CMSAbstractTransformation.)
Public method	GetMemberProfileUrl(Object)	Returns member profile URL. (Inherited from CMSAbstractTransformation.)
Public method	GetMemberProfileUrl(Object, String)	Returns member profile URL. (Inherited from CMSAbstractTransformation.)
Public method	GetMessageBoardUrl	Returns URL of the message board document. (Inherited from CMSAbstractTransformation.)
Public method	GetMessageBoardUrlForFeed	Returns URL of the message board document with feed parameter. (Inherited from CMSAbstractTransformation.)
Public method	GetMetaFileUrl	Returns URL of the specified meta file. (Inherited from CMSAbstractTransformation.)
Public method	GetNavigationUrl	Returns resolved (i.e. absolute) URL of data item (page) that currently being processed. Method reflects page navigation settings. (Inherited from CMSAbstractTransformation.)
Public method	GetNotEmpty	Returns first nonEmpty column. (Inherited from CMSAbstractTransformation.)
Public method	GetRSSDateTime	Gets time according to RFC 822 for RSS feeds. (Inherited from CMSAbstractTransformation.)
Public method	GetSearchedContent	Returns content parsed as XML if required and removes dynamic controls. (Inherited from CMSAbstractTransformation.)
Public method	GetSearchImageUrl	Returns URL to current search result item. (Inherited from CMSAbstractTransformation.)
Public method	GetSearchValue	Returns column value for current search result item. (Inherited from CMSAbstractTransformation.)
Public method	GetSharePointFileUrl	Gets URL for accessing file on SharePoint server. (Inherited from CMSAbstractTransformation.)
Public method	GetSharePointImageUrl	Gets URL for accessing an image on SharePoint server. (Inherited from CMSAbstractTransformation.)
Public method	GetSiteDateTime	Returns site date time according to site time zone. (Inherited from CMSAbstractTransformation.)
Public method	GetSitemapItem	Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority). (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	GetUIImageUrl(String, Boolean)	Gets UI image resolved path. (Inherited from CMSAbstractTransformation.)
Public method	GetUIImageUrl(String, Boolean, Boolean)	Gets UI image path. (Inherited from CMSAbstractTransformation.)
Public method	GetUrl(Object, Object)	Returns URL for the specified aliasPath and urlPath (preferable). (Inherited from CMSAbstractTransformation.)
Public method	GetUrl(Object, Object, Object)	Returns URL for the specified aliasPath and urlPath (preferable). (Inherited from CMSAbstractTransformation.)
Public method	GetUserAvatarImage(Int32, String)	Returns user avatar image. Datarow must contains 'AvatarGuid' and 'UserGender' columns. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	GetUserDateTime	Returns current user date time DateTime according to user time zone. (Inherited from CMSAbstractTransformation.)
Public method	GetUserProfileURL(Object)	Returns user profile URL. (Inherited from CMSAbstractTransformation.)
Public method	GetUserProfileURL(Object, String)	Returns user profile URL. (Inherited from CMSAbstractTransformation.)
Public method	HTMLEncode	Returns encoded text. (Inherited from CMSAbstractTransformation.)
Public method	If	If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	IfEmpty	Returns nonEmptyResult if value is null or empty, else returns emptyResult. (Inherited from CMSAbstractTransformation.)
Public method	IfImage	Returns isImage value if file is image. (Inherited from CMSAbstractTransformation.)
Public method	IfTrue	If input value is evaluated as True then 'true result' is returned, otherwise empty string is returned. (Inherited from CMSAbstractTransformation.)
Public method	IsCurrentDocument	Indicates if the document is current document. (Inherited from CMSAbstractTransformation.)
Public method	IsDocumentOnSelectedPath	Indicates if the document is on selected path. (Inherited from CMSAbstractTransformation.)
Public method	IsFirst	Indicates if current data item is the first. (Inherited from CMSAbstractTransformation.)
Public method	IsImageDocument	Indicates if the document is image. (Inherited from CMSAbstractTransformation.)
Public method	IsLast	Indicates it current data item is the last. (Inherited from CMSAbstractTransformation.)
Public method	LimitLength(Object, Int32)	Limits length of the given plain text. (Inherited from CMSAbstractTransformation.)
Public method	LimitLength(Object, Int32, String)	Limits length of the given plain text. (Inherited from CMSAbstractTransformation.)
Public method	LimitLength(Object, Int32, String, Boolean)	Limits length of the given plain text. (Inherited from CMSAbstractTransformation.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	Localize	Returns localized text. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	RemoveDynamicControls	Remove all dynamic controls macros from text. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	ResolveDiscussionMacros	Resolves the discussion macros. (Inherited from CMSAbstractTransformation.)
Public method	ResolveMacros	Resolves the macros in the given text (Inherited from CMSAbstractTransformation.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SearchHighlight	Highlight input text with dependence on current search keywords. (Inherited from CMSAbstractTransformation.)
Public method	SearchResultUrl	Returns URL for current search result. (Inherited from CMSAbstractTransformation.)
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. (Inherited from CMSAbstractTransformation.)
Public method	TrimSitePrefix	Trims the site prefix from user name(if any prefix found) (Inherited from CMSAbstractTransformation.)

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