Click or drag to resize
CMSErrorTransformation Class
Error transformation class.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 10.0.0
Syntax
C#
public class CMSErrorTransformation : CMSAbstractTransformation

The CMSErrorTransformation type exposes the following members.

Constructors
  NameDescription
Public methodCMSErrorTransformation
Top
Fields
  NameDescription
Protected fieldmDataControl
Parent data control.
(Inherited from CMSAbstractTransformation.)
Protected fieldmDataControlSearched
Returns true if the parent data control was already searched
(Inherited from CMSAbstractTransformation.)
Protected fieldmDocumentCustomData
Document custom data.
(Inherited from CMSAbstractTransformation.)
Protected fieldmEditableItems
Editable items (document content).
(Inherited from CMSAbstractTransformation.)
Protected fieldmNodeCustomData
Node custom data.
(Inherited from CMSAbstractTransformation.)
Protected fieldmObject
Object containing the data
(Inherited from CMSAbstractTransformation.)
Protected fieldmObjectLoaded
Flag whether the object was loaded or not
(Inherited from CMSAbstractTransformation.)
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from CMSAbstractTransformation.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from CMSAbstractTransformation.)
Protected fieldmTrackEvals
If true, the evals are tracked within this transformation
(Inherited from CMSAbstractTransformation.)
Top
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDataControl
Parent data control.
(Inherited from CMSAbstractTransformation.)
Public propertyDataItem
Gets the data item object for current binding context.
(Inherited from CMSAbstractTransformation.)
Public propertyDataItemCount
Gets the number of data items for the current binding context.
(Inherited from CMSAbstractTransformation.)
Public propertyDataItemIndex
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 propertyDataRowView
Returns current data row view.
(Inherited from CMSAbstractTransformation.)
Public propertyDisplayIndex
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 propertyDocumentCustomData
Document custom data.
(Inherited from CMSAbstractTransformation.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditableItems
Editable items (document content).
(Inherited from CMSAbstractTransformation.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyInnerException
Inner exception to display.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNodeCustomData
Node custom data.
(Inherited from CMSAbstractTransformation.)
Public propertyObject
Object with the data
(Inherited from CMSAbstractTransformation.)
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from CMSAbstractTransformation.)
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddCurrentCategoryParameter
Appends current category ID to given URL.
(Inherited from CMSAbstractTransformation.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodCreateChildControls
Creates the child controls.
(Overrides ControlCreateChildControls.)
Public methodDataBind
Data bind.
(Inherited from CMSAbstractTransformation.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEnsureMaximumLineLength
Limits line length of the given plain text.
(Inherited from CMSAbstractTransformation.)
Protected methodEnsureObject
Ensures the internal transformation object which provides the nested data
(Inherited from CMSAbstractTransformation.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
(Inherited from CMSAbstractTransformation.)
Public methodEvalBool
Evaluates the item data and converts it to the boolean.
(Inherited from CMSAbstractTransformation.)
Public methodEvalCDATA(String)
Evaluates the item data and return escaped CDATA.
(Inherited from CMSAbstractTransformation.)
Public methodEvalCDATA(String, Boolean)
Evaluates the item data and return escaped CDATA.
(Inherited from CMSAbstractTransformation.)
Protected methodEvalColumnInternal
Evaluates the data column
(Inherited from CMSAbstractTransformation.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from CMSAbstractTransformation.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from CMSAbstractTransformation.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from CMSAbstractTransformation.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from CMSAbstractTransformation.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from CMSAbstractTransformation.)
Protected methodEvalInternal
Evaluates the expression on the available data
(Inherited from CMSAbstractTransformation.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from CMSAbstractTransformation.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string non-html content.
(Inherited from CMSAbstractTransformation.)
Public methodEvalText(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 methodFormatDate
Format date without time part.
(Inherited from CMSAbstractTransformation.)
Public methodFormatDateTime
Format date time.
(Inherited from CMSAbstractTransformation.)
Public methodGetAbsoluteUrl(String)
Returns absolute URL from relative path.
(Inherited from CMSAbstractTransformation.)
Public methodGetAbsoluteUrl(String, SiteInfoIdentifier)
Returns absolute URL from relative path.
(Inherited from CMSAbstractTransformation.)
Public methodGetAge
Returns age according to DOB. If DOB is not set, returns unknownAge string.
(Inherited from CMSAbstractTransformation.)
Public methodGetAtomDateTime
Gets time according to RFC 3339 for Atom feeds.
(Inherited from CMSAbstractTransformation.)
Public methodGetAttachmentIcon
Returns HTML markup representing attachment icon.
(Inherited from CMSAbstractTransformation.)
Public methodGetAttachmentUrl
Returns URL of the attachment.
(Inherited from CMSAbstractTransformation.)
Public methodGetBadgeImage
Returns badge image tag.
(Inherited from CMSAbstractTransformation.)
Public methodGetBadgeName
Returns badge name.
(Inherited from CMSAbstractTransformation.)
Public methodGetBlogCommentUrl
Returns URL of the blog comment document.
(Inherited from CMSAbstractTransformation.)
Public methodGetBlogCommentUrlForFeed
Returns URL of the blog comment document with feed parameter.
(Inherited from CMSAbstractTransformation.)
Public methodGetColumnName(String)
Returns first column which is present and not empty.
(Inherited from CMSAbstractTransformation.)
Public methodGetColumnName(String, Boolean)
Returns first column which is present.
(Inherited from CMSAbstractTransformation.)
Public methodGetCustomDateTime
Returns date time with dependence on selected time zone.
(Inherited from CMSAbstractTransformation.)
Public methodGetDataControlValue(String)
Gets the Data control value.
(Inherited from CMSAbstractTransformation.)
Public methodGetDate
Returns date from the provided date-time value.
(Inherited from CMSAbstractTransformation.)
Public methodGetDateTime(DateTime)
Returns date time with dependence on current ITimeZone manager time zone settings.
(Inherited from CMSAbstractTransformation.)
Public methodGetDateTime(Object)
Returns date time with dependence on current ITimeZone manager time zone settings.
(Inherited from CMSAbstractTransformation.)
Public methodGetDateTime(String)
Returns date and time string.
(Inherited from CMSAbstractTransformation.)
Public methodGetDateTime(String, String)
Returns date and time in given format.
(Inherited from CMSAbstractTransformation.)
Public methodGetDateTimeString
Returns string representation of date time with dependence on current ITimeZone manager time zone settings.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentCssClass
Gets document CSS class comparing the current document node alias path.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentLink
Returns a complete HTML code of the link to the currently rendered document.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentLink(Boolean)
Returns a complete HTML code of the link to the currently rendered document.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentUrl
Returns URL of the currently rendered document.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentUrl(Object)
Returns URL of the given document.
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentUrl(Object, Object)
Returns URL of the given document (for use with document selector).
(Inherited from CMSAbstractTransformation.)
Public methodGetDocumentUrlForFeed
Returns URL of the currently rendered document with feed parameter.
(Inherited from CMSAbstractTransformation.)
Public methodGetEditableImage
Returns a complete HTML code of the image that is specified by editable image ID.
(Inherited from CMSAbstractTransformation.)
Public methodGetEditableImageUrl
Gets the editable image value.
(Inherited from CMSAbstractTransformation.)
Public methodGetEditableValue
Gets the editable control value.
(Inherited from CMSAbstractTransformation.)
Public methodGetEventDateString
Returns string representation of event time.
(Inherited from CMSAbstractTransformation.)
Protected methodGetFeedName
Returns safe feed name. Checks "FeedName" and "InstanceGUID" columns in data controls.
(Inherited from CMSAbstractTransformation.)
Public methodGetFileIcon
Returns HTML markup representing file icon.
(Inherited from CMSAbstractTransformation.)
Public methodGetFileIconClass
Returns font icon class for specified file extension.
(Inherited from CMSAbstractTransformation.)
Public methodGetFileUrl(Object, Object, String)
Returns URL of the attachment.
(Inherited from CMSAbstractTransformation.)
Public methodGetFileUrl(Object, String, String)
Returns URL of the attachment stored in the given column name.
(Inherited from CMSAbstractTransformation.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetForumPostUrl
Returns URL of the specified forum post.
(Inherited from CMSAbstractTransformation.)
Public methodGetForumPostUrlForFeed
Returns URL of the specified forum post with feed parameter.
(Inherited from CMSAbstractTransformation.)
Public methodGetGender
Returns gender of the user.
(Inherited from CMSAbstractTransformation.)
Public methodGetGroupAvatarImage(Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
(Inherited from CMSAbstractTransformation.)
Public methodGetGroupAvatarImage(Object, Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
(Inherited from CMSAbstractTransformation.)
Public methodGetGroupAvatarImage(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 methodGetGroupProfileUrl(Object)
Returns group profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetGroupProfileUrl(Object, String)
Returns group profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetImage(Object, Int32)
Returns a complete HTML code of the image that is specified in the given column.
(Inherited from CMSAbstractTransformation.)
Public methodGetImage(Object, Int32, Int32)
Returns a complete HTML code of the image that is specified in the given column.
(Inherited from CMSAbstractTransformation.)
Public methodGetImage(Object, Object, Object, Object, Object)
Returns a complete HTML code of the image that is specified in the given column.
(Inherited from CMSAbstractTransformation.)
Public methodGetImageByUrl(Object, Int32)
Returns a complete HTML code of the image that is specified by the given URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetImageByUrl(Object, Int32, Int32)
Returns a complete HTML code of the image that is specified by the given URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetImageByUrl(Object, Object, Object, Object, Object)
Returns a complete HTML code of the image that is specified by the given url.
(Inherited from CMSAbstractTransformation.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetMediaFileUrl
Returns URL of the specified media file.
(Inherited from CMSAbstractTransformation.)
Public methodGetMediaFileUrlForFeed
Returns URL of the specified media file with feed parameter.
(Inherited from CMSAbstractTransformation.)
Public methodGetMemberProfileUrl(Object)
Returns member profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetMemberProfileUrl(Object, String)
Returns member profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetMessageBoardUrl
Returns URL of the message board document.
(Inherited from CMSAbstractTransformation.)
Public methodGetMessageBoardUrlForFeed
Returns URL of the message board document with feed parameter.
(Inherited from CMSAbstractTransformation.)
Public methodGetMetaFileUrl
Returns URL of the specified meta file.
(Inherited from CMSAbstractTransformation.)
Public methodGetNavigationUrl
Returns resolved (i.e. absolute) URL of data item (page) that currently being processed. Method reflects page navigation settings.
(Inherited from CMSAbstractTransformation.)
Public methodGetNotEmpty
Returns first nonEmpty column.
(Inherited from CMSAbstractTransformation.)
Public methodGetRSSDateTime
Gets time according to RFC 822 for RSS feeds.
(Inherited from CMSAbstractTransformation.)
Public methodGetSearchedContent
Returns content parsed as XML if required and removes dynamic controls.
(Inherited from CMSAbstractTransformation.)
Public methodGetSearchImageUrl
Returns URL to current search result item.
(Inherited from CMSAbstractTransformation.)
Public methodGetSearchValue
Returns column value for current search result item.
(Inherited from CMSAbstractTransformation.)
Public methodGetSharePointFileUrl
Gets URL for accessing file on SharePoint server.
(Inherited from CMSAbstractTransformation.)
Public methodGetSharePointImageUrl
Gets URL for accessing an image on SharePoint server.
(Inherited from CMSAbstractTransformation.)
Public methodGetSiteDateTime
Returns site date time according to site time zone.
(Inherited from CMSAbstractTransformation.)
Public methodGetSitemapItem
Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority).
(Inherited from CMSAbstractTransformation.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetUIImageUrl(String)
Gets UI image resolved path.
(Inherited from CMSAbstractTransformation.)
Public methodGetUIImageUrl(String, Boolean)
Gets UI image resolved path.
(Inherited from CMSAbstractTransformation.)
Public methodGetUIImageUrl(String, Boolean, Boolean)
Gets UI image path.
(Inherited from CMSAbstractTransformation.)
Public methodGetUrl(Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
(Inherited from CMSAbstractTransformation.)
Public methodGetUrl(Object, Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
(Inherited from CMSAbstractTransformation.)
Public methodGetUserAvatarImage(Int32, String)
Returns user avatar image. Datarow must contains 'AvatarGuid' and 'UserGender' columns.
(Inherited from CMSAbstractTransformation.)
Public methodGetUserAvatarImage(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 methodGetUserAvatarImage(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 methodGetUserAvatarImage(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 methodGetUserAvatarImageUrl(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 methodGetUserAvatarImageUrl(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 methodGetUserDateTime
Returns current user date time DateTime according to user time zone.
(Inherited from CMSAbstractTransformation.)
Public methodGetUserProfileURL(Object)
Returns user profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodGetUserProfileURL(Object, String)
Returns user profile URL.
(Inherited from CMSAbstractTransformation.)
Public methodHTMLEncode
Returns encoded text.
(Inherited from CMSAbstractTransformation.)
Public methodIf
If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned.
(Inherited from CMSAbstractTransformation.)
Public methodIfCompare
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.
(Inherited from CMSAbstractTransformation.)
Public methodIfEmpty
Returns nonEmptyResult if value is null or empty, else returns emptyResult.
(Inherited from CMSAbstractTransformation.)
Public methodIfImage
Returns isImage value if file is image.
(Inherited from CMSAbstractTransformation.)
Public methodIfTrue
If input value is evaluated as True then 'true result' is returned, otherwise empty string is returned.
(Inherited from CMSAbstractTransformation.)
Public methodIsCurrentDocument
Indicates if the document is current document.
(Inherited from CMSAbstractTransformation.)
Public methodIsDocumentOnSelectedPath
Indicates if the document is on selected path.
(Inherited from CMSAbstractTransformation.)
Public methodIsFirst
Indicates if current data item is the first.
(Inherited from CMSAbstractTransformation.)
Public methodIsImageDocument
Indicates if the document is image.
(Inherited from CMSAbstractTransformation.)
Public methodIsLast
Indicates it current data item is the last.
(Inherited from CMSAbstractTransformation.)
Public methodLimitLength(Object, Int32)
Limits length of the given plain text.
(Inherited from CMSAbstractTransformation.)
Public methodLimitLength(Object, Int32, String)
Limits length of the given plain text.
(Inherited from CMSAbstractTransformation.)
Public methodLimitLength(Object, Int32, String, Boolean)
Limits length of the given plain text.
(Inherited from CMSAbstractTransformation.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLocalize
Returns localized text.
(Inherited from CMSAbstractTransformation.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRemoveDiscussionMacros
Remove all types of discussion macros from text.
(Inherited from CMSAbstractTransformation.)
Public methodRemoveDynamicControls
Remove all dynamic controls macros from text.
(Inherited from CMSAbstractTransformation.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveCurrentPath
Resolves the given alias path, applies the path segment to the given format string {0} for level 0.
(Inherited from CMSAbstractTransformation.)
Public methodResolveDiscussionMacros
Resolves the discussion macros.
(Inherited from CMSAbstractTransformation.)
Public methodResolveMacros
Resolves the macros in the given text
(Inherited from CMSAbstractTransformation.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSearchHighlight
Highlight input text with dependence on current search keywords.
(Inherited from CMSAbstractTransformation.)
Public methodSearchResultUrl
Returns URL for current search result.
(Inherited from CMSAbstractTransformation.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodStripTags
Remove HTML tags from text.
(Inherited from CMSAbstractTransformation.)
Public methodTrimSitePrefix
Trims the site prefix from user name(if any prefix found)
(Inherited from CMSAbstractTransformation.)
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also