CloneSettings Class

Class encapsulating parameters for object cloning (used in InsertAsClone settings)

Inheritance Hierarchy

System.Object
  CMS.DataEngine.CloneSettings

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public class CloneSettings

The CloneSettings type exposes the following members.

Constructors

	Name	Description
Public method	CloneSettings

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AfterCloneInsertCallback	Handles actions right after inserting the clone object.
Public property	AfterCloneStructureInsertCallback	Handles actions after processing main object and all the child, binging, sitebindigns, ... etc. objects.
Public property	AssignToSiteID	If object has SiteBinding than a binding for given site is created after the object is cloned.
Public property	BeforeCloneInsertCallback	Handles actions before inserting the clone. Use to further modify given object according to settings.
Public property	CloneBase	Gets or sets the root object - the object the clonning procedure was called on (for example when cloning country with states, in the states the root object will be still the country).
Public property	CloneToSiteID	ID of the site to clone the object to. Only for site objects. If this value is 0, object will be clonned under the site of the original object unless the object type has SupportsGlobalObjects = true. In that case, 0 means that an object is cloned as a global object.
Public property	CodeName	New code name. If null, automatically generated unique code name is generated.
Public property	CustomParameters	Hashtable with custom parameters (for special cases such as BizForms, CustomTables, Webparts, etc.) where additional operations have to be done.
Public property	DisplayName	New display name. If null, automatically generated unique display name is generated.
Public property	ExcludedBindingTypes	Gets or sets the list of binding object types which should be clonned, if null than all child object types are clonned.
Public property	ExcludedChildTypes	Gets or sets the list of child object types which should be clonned, if null than all child object types are clonned.
Public property	ExcludedOtherBindingTypes	Gets or sets the list of other binding object types which should be clonned, if null than all child object types are clonned.
Public property	IncludeBindings	If true, binding objects are included in the result.
Public property	IncludeChildren	If true, child objects are included in the result.
Public property	IncludeMetafiles	If true, metafiles of the object are included in the result as well.
Public property	IncludeOtherBindings	If true, other binding objects are included in the result.
Public property	IncludeSiteBindings	If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
Public property	KeepFieldsTranslated	If true, cloned object will keep all the fields which use localization macros {$res.string$} without change. If false, cloned object will replace the localization with its translation in the default culture. This setting does not influence DislpayName - this will be always replaced by its translation.
Public property	KeepOriginalSiteID	If true, CloneToSiteID is ignored and SiteID of the original object is kept.
Public property	MaxRelativeLevel	Determines maximal level of the relationship (prent-child). -1 means all levels, 0 means no child objects, 1 means first level of children, etc.
Public property	Parameter	Custom parameter passed within the settings (for handlers usage, etc.).
Public property	ParentID	ID of the parent object to which the clonned object should be assigned.
Public property	Translations	Gets or sets the translation helper object (always at least empty instance, cannot return null) which provides translation Original object ID -> Cloned object ID.