Click or drag to resize
CMSErrorTransformation Class
Error transformation class.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.DocumentEngine.Web.UICMSAbstractTransformation
            CMS.DocumentEngine.Web.UICMSErrorTransformation

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
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 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 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.)
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.)
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 methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from CMSAbstractTransformation.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(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 AbstractUserControl.)
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 methodGetAttachmentUrl Obsolete.
Returns friendly URL of the attachment.
(Inherited from CMSAbstractTransformation.)
Public methodGetAttachmentUrlByDocumentId Obsolete.
Returns friendly URL of the attachment.
(Inherited from CMSAbstractTransformation.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
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 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 methodHTMLEncode
Returns encoded text.
(Inherited from CMSAbstractTransformation.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
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.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
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 methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
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 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.)
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