DeleteDocumentSettings Class

Container for settings used when deleting document.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.BaseDocumentSettings
    CMS.DocumentEngine.DeleteDocumentSettings

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

Syntax

public class DeleteDocumentSettings : BaseDocumentSettings

The DeleteDocumentSettings type exposes the following members.

Constructors

	Name	Description
Public method	DeleteDocumentSettings()	Default constructor
Public method	DeleteDocumentSettings(DeleteDocumentSettings)	Copying constructor.
Public method	DeleteDocumentSettings(TreeNode, Boolean, Boolean, TreeProvider)	Creates and initializes DeleteDocumentSettings object.
Public method	DeleteDocumentSettings(TreeNode, TreeProvider, Boolean, Boolean, DeleteProductActionEnum, String, ArrayList, TreeNode, Int32, Boolean)	Obsolete. Creates and initializes DeleteDocumentSettings object.

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	AlternatingDocument	Alternating document
Public property	AlternatingDocumentCopyAllPaths	Indicates whether document aliases should be copied to the alternating document
Public property	AlternatingDocumentMaxLevel	Maximal level of deleted document which should be used as source for alternating document
Public property	DeleteAllCultures	Indicates whether all culture version of the specified document are to be deleted.
Public property	DeletedNodeIDs	List of the deleted node IDs.
Public property	DeleteProductAction	Obsolete. Action to be performed with SKU (product) bound to deleted document(s).
Public property	DestroyHistory	Indicates whether the history of the specified document is to be deleted.
Public property	Node	Document node to process. (Inherited from BaseDocumentSettings.)
Public property	Tree	TreeProvider to use. (Inherited from BaseDocumentSettings.)
Public property	WebRootFullPath	Full path to the web root folder.