ObjectTransformation Class

Object transformation control. Transforms an object retrieved by ObjectID using specified transformation. Multiple object transformations on a single page are optimized to retrieve all used objects with a single query for better performance.

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

Syntax

public class ObjectTransformation : ObjectTransformationBase

The ObjectTransformation type exposes the following members.

Constructors

	Name	Description
Public method	ObjectTransformation()	Constructor.
Public method	ObjectTransformation(String, Int32)	Constructor.

Properties

	Name	Description
Public property	ContextResolver	Macro resolver to use (Inherited from ObjectTransformationBase.)
Public property	DataItem	Data item for the transformation template (Inherited from ObjectTransformationBase.)
Public property	DataItemIndex	Data item index (Inherited from ObjectTransformationBase.)
Public property	DataProvider	Data provider for this transformation
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. (Inherited from ObjectTransformationBase.)
Public property	DisplayIndex	Display index (Inherited from ObjectTransformationBase.)
Public property	EncodeOutput	If true, the output is encoded. Default value is true. (Inherited from ObjectTransformationBase.)
Public property	LocalizeStrings	If true, the output localizes the string macros. (Inherited from ObjectTransformationBase.)
Public property	NoDataTransformation	Transformation used in case the object was not found (Inherited from ObjectTransformationBase.)
Public property	ObjectID	Object ID.
Protected property	ObjectRequested	If true, the object was already requested (Inherited from ObjectTransformationBase.)
Public property	ObjectType	Object type. (Inherited from ObjectTransformationBase.)
Public property	Transformation	Transformation - Column name (e.g. "ResourceName"), Internal UniGrid transformation (e.g. "#yesno") or a macro (e.g. "{% FirstName %} {% LastName %}"). (Inherited from ObjectTransformationBase.)
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 (Inherited from ObjectTransformationBase.)
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. (Inherited from ObjectTransformationBase.)

Methods

	Name	Description
Protected method	GetDefaultParameter	Gets the default parameter for the transformation (Overrides ObjectTransformationBase.GetDefaultParameter().)
Protected method	GetObject()	Gets the object used by the transformation (Overrides ObjectTransformationBase.GetObject().)
Protected method	GetObject(String, Int32, Boolean)	Gets the given object.
Protected method	RegisterObject	Register required object. (Overrides ObjectTransformationBase.RegisterObject().)
Protected method	Render	Renders the control. (Inherited from ObjectTransformationBase.)
Protected method	RequireObject	Marks the given object as required.
Public method	ToString	Overrides base method and returns transformed result as a text. (Inherited from ObjectTransformationBase.)

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