ObjectTransformationBase Class

Base class for object transformation

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.UIControls.ObjectTransformationBase
        CMS.UIControls.ObjectTransformation

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0

Syntax

public abstract class ObjectTransformationBase : PlaceHolder, 
	IDataItemContainer, INamingContainer, IOutputEncodingControl

The ObjectTransformationBase type exposes the following members.

Constructors

	Name	Description
Protected method	ObjectTransformationBase	Constructor.

Properties

	Name	Description
Public property	ContextResolver	Macro resolver to use
Public property	DataItem	Data item for the transformation template
Public property	DataItemIndex	Data item index
Public property	DirectIfNotCached	If true, the component is allowed to get the objects one by one directly from provider if not found registered. Default false.
Public property	DisplayIndex	Display index
Public property	EncodeOutput	If true, the output is encoded. Default value is true.
Public property	LocalizeStrings	If true, the output localizes the string macros.
Public property	NoDataTransformation	Transformation used in case the object was not found
Protected property	ObjectRequested	If true, the object was already requested
Public property	ObjectType	Object type.
Public property	Transformation	Transformation - Column name (e.g. "ResourceName"), Internal UniGrid transformation (e.g. "#yesno") or a macro (e.g. "{% FirstName %} {% LastName %}").
Public property	TransformationName	Transformation name. Supports the following formats of transformation name: [Some text with macros] - Inline transformation cms.user.sometransformation - Transformation full name from database ~/SomePath/SomeControl.ascx - Path to transformation user control
Public property	UseEmptyInfoForObjectLimitedByLicense	Gets or sets the value that indicates whether empty info should be used for objects limited by license. Use this property to true if object values need not to be correct and the purpose of the displayed object is object itself.

Methods

	Name	Description
Protected method	GetDefaultParameter	Gets the default parameter for the transformation
Protected method	GetObject	Gets the object used by the transformation
Protected method	RegisterObject	Register required object.
Protected method	Render	Renders the control. (Overrides Control.Render(HtmlTextWriter).)
Public method	ToString	Overrides base method and returns transformed result as a text. (Overrides Object.ToString().)

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