CopyDocumentSettings Class

Container for settings used when copying document.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.BaseDocumentSettings
    CMS.DocumentEngine.CopyDocumentSettings

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

Syntax

public class CopyDocumentSettings : BaseDocumentSettings

The CopyDocumentSettings type exposes the following members.

Constructors

	Name	Description
Public method	CopyDocumentSettings()	Default constructor
Public method	CopyDocumentSettings(CopyDocumentSettings, Boolean)	Copy constructor
Public method	CopyDocumentSettings(TreeNode, TreeNode, TreeProvider)	Parametric constructor
Public method	CopyDocumentSettings(TreeNode, TreeProvider, Int32, Boolean, Int32, Int32, Boolean, String)	Obsolete. Parametric constructor

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	CloneSKU	If set to true SKU bound to copied document will be cloned.
Public property	CopyPermissions	Indicates if the document permissions should be copied
Public property	CheckSiteCulture	If set to true document will be copied only if target site has assigned the culture document has.
Public property	IncludeChildNodes	Indicates whether child nodes should be copied as well.
Public property	NewDocumentName	New document name
Public property	NewDocumentsGroup	Group of the new documents
Public property	NewDocumentsOwner	Owner of the new documents
Public property	Node	Document node to process. (Inherited from BaseDocumentSettings.)
Public property	ProcessingChildNodes	Indicates that child nodes are being copied recursively.
Public property	TargetNode	Target node
Public property	TargetParentNodeId	Obsolete. Target location
Public property	Tree	TreeProvider to use. (Inherited from BaseDocumentSettings.)