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: 13.0.131

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	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	ComponentName	Component name (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	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	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.)
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).)
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 "'". (Inherited from AbstractUserControl.)
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	GetAttachmentUrl	Obsolete. Returns friendly URL of the attachment.
Public method	GetAttachmentUrlByDocumentId	Obsolete. Returns friendly URL of the attachment.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
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	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	HTMLEncode	Returns encoded text.
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
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.)
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
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.)

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