Click or drag to resize
CMSAbstractTransformation Class
Base transformation class.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
public class CMSAbstractTransformation : AbstractUserControl, 
	IDataItemContainer, INamingContainer, IRelatedData

The CMSAbstractTransformation type exposes the following members.

Constructors
  NameDescription
Public methodCMSAbstractTransformation
Top
Fields
  NameDescription
Protected fieldStatic membermCDATARegExp
Regular expression for CDATA.
Protected fieldmDataControl
Parent data control.
Protected fieldmDataControlSearched
Returns true if the parent data control was already searched
Protected fieldmDocumentCustomData
Document custom data.
Protected fieldmEditableItems
Editable items (document content).
Protected fieldmNodeCustomData
Node custom data.
Protected fieldmObject
Object containing the data
Protected fieldmObjectLoaded
Flag whether the object was loaded or not
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRelatedDataLoaded
Related data is loaded.
Protected fieldmTrackEvals
If true, the evals are tracked within this transformation
Top
Properties
  NameDescription
Public propertyStatic memberCDATARegExp
URL regular expression.
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.
Public propertyDataItem
Gets the data item object for current binding context.
Public propertyDataItemCount
Gets the number of data items for the current binding context.
Public propertyDataItemIndex
Gets the data item index for current transformation container You have to use Container.DataItemIndex for index in current binding context
Public propertyDataRowView
Returns current data row view.
Public propertyDisplayIndex
Gets the display index for current transformation container You have to use Container.DisplayIndex for display index in current binding context
Public propertyDocumentCustomData
Document custom data.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditableItems
Editable items (document content).
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyStatic memberMethods
Methods provided by the transformation
Public propertyNodeCustomData
Node custom data.
Public propertyObject
Object with the data
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
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.
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.)
Public methodDataBind
Data bind.
(Overrides ControlDataBind.)
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.
Protected methodEnsureObject
Ensures the internal transformation object which provides the nested data
Public methodEval(String)
Evaluates the item data (safe version).
(Overrides AbstractUserControlEval(String).)
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.
(Overrides AbstractUserControlEval(String).)
Public methodEvalBool
Evaluates the item data and converts it to the boolean.
(Overrides AbstractUserControlEvalBool(String).)
Public methodEvalCDATA(String)
Evaluates the item data and return escaped CDATA.
Public methodEvalCDATA(String, Boolean)
Evaluates the item data and return escaped CDATA.
Protected methodEvalColumnInternal
Evaluates the data column
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Overrides AbstractUserControlEvalDateTime(String).)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Overrides AbstractUserControlEvalDecimal(String).)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Overrides AbstractUserControlEvalDouble(String).)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Overrides AbstractUserControlEvalGuid(String).)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Overrides AbstractUserControlEvalHTML(String).)
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.
(Overrides AbstractUserControlEvalInteger(String).)
Protected methodEvalInternal
Evaluates the expression on the available data
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Overrides AbstractUserControlEvalJSString(String).)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string non-html content.
(Overrides AbstractUserControlEvalText(String).)
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.
(Overrides AbstractUserControlEvalText(String, Boolean).)
Public methodFormatDate
Format date without time part.
Public methodFormatDateTime
Format date time.
Public methodGetAbsoluteUrl(String)
Returns absolute URL from relative path.
Public methodGetAbsoluteUrl(String, SiteInfoIdentifier)
Returns absolute URL from relative path.
Public methodGetAge
Returns age according to DOB. If DOB is not set, returns unknownAge string.
Public methodGetAtomDateTime
Gets time according to RFC 3339 for Atom feeds.
Public methodGetAttachmentIcon
Returns HTML markup representing attachment icon.
Public methodGetAttachmentUrl
Returns friendly URL of the attachment.
Public methodGetAttachmentUrlByDocumentId
Returns friendly URL of the attachment.
Public methodGetAttachmentUrlByGUID
Returns URL of the attachment based on given GUID.
Public methodGetBadgeImage
Returns badge image tag.
Public methodGetBadgeName
Returns badge name.
Public methodGetBlogCommentUrl
Returns URL of the blog comment document.
Public methodGetBlogCommentUrlForFeed
Returns URL of the blog comment document with feed parameter.
Public methodGetColumnName(String)
Returns first column which is present and not empty.
Public methodGetColumnName(String, Boolean)
Returns first column which is present.
Public methodGetCustomDateTime
Returns date time with dependence on selected time zone.
Public methodGetDataControlValue(String)
Gets the Data control value.
Public methodGetDataControlValueReturnType(String)
Gets the Data control value.
Public methodGetDate
Returns date from the provided date-time value.
Public methodGetDateTime(DateTime)
Returns date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDateTime(Object)
Returns date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDateTime(String)
Returns date and time string.
Public methodGetDateTime(String, String)
Returns date and time in given format.
Public methodGetDateTimeString
Returns string representation of date time with dependence on current ITimeZone manager time zone settings.
Public methodGetDocumentCssClass
Gets document CSS class comparing the current document node alias path.
Public methodGetDocumentLink
Returns a complete HTML code of the link to the currently rendered document.
Public methodGetDocumentLink(Boolean)
Returns a complete HTML code of the link to the currently rendered document.
Public methodGetDocumentUrl
Returns URL of the currently rendered document.
Public methodGetDocumentUrl(Object) Obsolete.
Returns URL of the given document.
Public methodGetDocumentUrl(Object, Object) Obsolete.
Returns URL of the given document (for use with document selector).
Public methodGetDocumentUrlByGUID
Returns URL of the given document.
Public methodGetDocumentUrlById
Returns URL of the given document.
Public methodGetDocumentUrlForFeed
Returns URL of the currently rendered document with feed parameter.
Public methodGetEditableImage
Returns a complete HTML code of the image that is specified by editable image ID.
Public methodGetEditableImageUrl
Gets the editable image value.
Public methodGetEditableValue
Gets the editable control value.
Public methodGetEventDateString
Returns string representation of event time.
Protected methodGetFeedName
Returns safe feed name. Checks "FeedName" and "InstanceGUID" columns in data controls.
Public methodGetFileIcon
Returns HTML markup representing file icon.
Public methodGetFileIconClass
Returns font icon class for specified file extension.
Public methodGetFileUrl(Object, Object, String) Obsolete.
Returns URL of the attachment.
Public methodGetFileUrl(Object, String, String) Obsolete.
Returns URL of the attachment stored in the given column name.
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.
Public methodGetForumPostUrlForFeed
Returns URL of the specified forum post with feed parameter.
Public methodGetGender
Returns gender of the user.
Public methodGetGroupAvatarImage(Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupAvatarImage(Object, Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupAvatarImage(Object, Int32, Int32, Int32, Object)
Returns group avatar image tag, if avatar is not defined returns default group if is defined.
Public methodGetGroupProfileUrl(Object)
Returns group profile URL.
Public methodGetGroupProfileUrl(Object, String)
Returns group profile URL.
Public methodGetImage(Object, Int32)
Returns a complete HTML code of the image that is specified in the given column.
Public methodGetImage(Object, Int32, Int32)
Returns a complete HTML code of the image that is specified in the given column.
Public methodGetImage(Object, Object, Object, Object, Object)
Returns a complete HTML code of the image that is specified in the given column.
Public methodGetImageByUrl(Object, Int32)
Returns a complete HTML code of the image that is specified by the given URL.
Public methodGetImageByUrl(Object, Int32, Int32)
Returns a complete HTML code of the image that is specified by the given URL.
Public methodGetImageByUrl(Object, Object, Object, Object, Object)
Returns a complete HTML code of the image that is specified by the given url.
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.
Public methodGetMediaFileUrlForFeed
Returns URL of the specified media file with feed parameter.
Public methodGetMemberProfileUrl(Object)
Returns member profile URL.
Public methodGetMemberProfileUrl(Object, String)
Returns member profile URL.
Public methodGetMessageBoardUrl
Returns URL of the message board document.
Public methodGetMessageBoardUrlForFeed
Returns URL of the message board document with feed parameter.
Public methodGetMetaFileUrl
Returns URL of the specified meta file.
Public methodGetNavigationUrl
Returns resolved (i.e. absolute) URL of data item (page) that currently being processed. Method reflects page navigation settings.
Public methodGetNotEmpty
Returns first nonEmpty column.
Public methodGetRSSDateTime
Gets time according to RFC 822 for RSS feeds.
Public methodGetSearchedContent
Returns content parsed as XML if required and removes dynamic controls.
Public methodGetSearchImageUrl
Returns URL to current search result item.
Public methodGetSearchValue
Returns column value for current search result item.
Public methodGetSharePointFileUrl
Gets URL for accessing file on SharePoint server.
Public methodGetSharePointImageUrl
Gets URL for accessing an image on SharePoint server.
Public methodGetSiteDateTime
Returns site date time according to site time zone.
Public methodGetSitemapItem
Returns sitemap XML element for specified type (loc, lastmod, changefreq, priority).
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.
Public methodGetUIImageUrl(String, Boolean)
Gets UI image resolved path.
Public methodGetUIImageUrl(String, Boolean, Boolean)
Gets UI image path.
Public methodGetUrl(Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
Public methodGetUrl(Object, Object, Object)
Returns URL for the specified aliasPath and urlPath (preferable).
Public methodGetUserAvatarImage(Int32, String)
Returns user avatar image. Datarow must contains 'AvatarGuid' and 'UserGender' columns.
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.
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.
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.
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.
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.
Public methodGetUserDateTime
Returns current user date time DateTime according to user time zone.
Public methodStatic memberGetUserFullName
Returns user full name.
Public methodGetUserProfileURL(Object)
Returns user profile URL.
Public methodGetUserProfileURL(Object, String)
Returns user profile URL.
Public methodHTMLEncode
Returns encoded text.
Public methodIf
If input value is evaluated as True then 'true result' is returned, otherwise 'false result' is returned.
Public methodIfCompare
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 methodIfEmpty
Returns nonEmptyResult if value is null or empty, else returns emptyResult.
Public methodIfImage
Returns isImage value if file is image.
Public methodIfTrue
If input value is evaluated as True then 'true result' is returned, otherwise empty string is returned.
Public methodIsCurrentDocument
Indicates if the document is current document.
Public methodIsDocumentOnSelectedPath
Indicates if the document is on selected path.
Public methodIsFirst
Indicates if current data item is the first.
Public methodIsImageDocument
Indicates if the document is image.
Public methodIsLast
Indicates it current data item is the last.
Public methodLimitLength(Object, Int32)
Limits length of the given plain text.
Public methodLimitLength(Object, Int32, String)
Limits length of the given plain text.
Public methodLimitLength(Object, Int32, String, Boolean)
Limits length of the given plain text.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLocalize
Returns localized text.
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.
Public methodRemoveDynamicControls
Remove all dynamic controls macros from text.
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.
Public methodResolveDiscussionMacros
Resolves the discussion macros.
Public methodResolveMacros
Resolves the macros in the given text
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSearchHighlight
Highlight input text with dependence on current search keywords.
Public methodSearchResultUrl
Returns URL for current search result.
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.)
Public methodStripTags
Remove HTML tags from text.
Public methodTrimSitePrefix
Trims the site prefix from user name(if any prefix found)
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