DeleteDocumentAction Class

Class for document deletion action

Inheritance Hierarchy

System.Object
  CMS.WorkflowEngine.BaseWorkflowAction<TreeNode, BaseInfo, WorkflowActionEnum>
    CMS.DocumentEngine.DocumentWorkflowAction
      CMS.DocumentEngine.BaseDocumentAction
        CMS.DocumentEngine.DeleteDocumentAction

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

Syntax

public class DeleteDocumentAction : BaseDocumentAction

The DeleteDocumentAction type exposes the following members.

Constructors

	Name	Description
Public method	DeleteDocumentAction

Properties

	Name	Description
Public property	ActionDefinition	Action definition. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	ActionStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Arguments	Action arguments (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Comment	Comment used when action moves to next step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	DeleteAllCultures	Indicates if all cultures should be deleted.
Protected property	DestroyDocument	Indicates if the document should be destroyed.
Public property	InfoObject	Current info object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InitialStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	MacroResolver	Macro resolver for action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Manager	Manager. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	Node	Current document. (Inherited from DocumentWorkflowAction.)
Public property	OriginalStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Parameters	Parameters of action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	SourceAliasPath	Source alias path (Inherited from BaseDocumentAction.)
Protected property	SourceCombineWithDefaultCulture	Specifies if return the default culture document when specified culture not found. (Inherited from BaseDocumentAction.)
Protected property	SourceCulture	Source document culture code (Inherited from BaseDocumentAction.)
Protected property	SourceNode	Node to be copied (Inherited from BaseDocumentAction.)
Protected property	SourceSite	Source site (Inherited from BaseDocumentAction.)
Protected property	SourceSiteName	Source site name (Inherited from BaseDocumentAction.)
Public property	StateObject	Current state object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	User	User running action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Workflow	Current workflow. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	WorkflowManager	Workflow manager (Inherited from DocumentWorkflowAction.)

Methods

	Name	Description
Public method	Execute	Executes action (Overrides BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.Execute().)
Protected method	GetDefaultMacroResolver	Prepares macro resolver for usage. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	GetResolvedParameter<ReturnType>	Gets resolved value of parameter. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs message to event log. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	Process	Processes action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	RefreshNode	Refreshes node instance (Inherited from DocumentWorkflowAction.)