Click or drag to resize
DeleteDocumentAction Class
Class for document deletion action
Inheritance Hierarchy
SystemObject
  CMS.WorkflowEngineBaseWorkflowActionTreeNode, BaseInfo, WorkflowActionEnum
    CMS.DocumentEngineDocumentWorkflowAction
      CMS.DocumentEngineBaseDocumentAction
        CMS.DocumentEngineDeleteDocumentAction

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
Syntax
C#
public class DeleteDocumentAction : BaseDocumentAction

The DeleteDocumentAction type exposes the following members.

Constructors
  NameDescription
Public methodDeleteDocumentAction
Top
Properties
  NameDescription
Public propertyActionDefinition
Action definition.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyActionStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyAlternatingAliasPath
Alternating alias path
Protected propertyAlternatingDocumentChildren
Indicates if child documents should be alternated.
Protected propertyAlternatingDocumentCopyAllPaths
Indicates if aliases should be copied.
Protected propertyAlternatingNode
Alternating node
Public propertyArguments
Action arguments
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyComment
Comment used when action moves to next step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyDeleteAllCultures
Indicates if all cultures should be deleted.
Protected propertyDestroyDocument
Indicates if the document should be destroyed.
Public propertyInfoObject
Current info object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyInitialStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyMacroResolver
Macro resolver for action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyManager
Manager.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyNode
Current document.
(Inherited from DocumentWorkflowAction.)
Public propertyOriginalStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyParameters
Parameters of action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertySourceAliasPath
Source alias path
(Inherited from BaseDocumentAction.)
Protected propertySourceCombineWithDefaultCulture
Specifies if return the default culture document when specified culture not found.
(Inherited from BaseDocumentAction.)
Protected propertySourceCulture
Source document culture code
(Inherited from BaseDocumentAction.)
Protected propertySourceNode
Node to be copied
(Inherited from BaseDocumentAction.)
Protected propertySourceSite
Source site
(Inherited from BaseDocumentAction.)
Protected propertySourceSiteName
Source site name
(Inherited from BaseDocumentAction.)
Public propertyStateObject
Current state object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyUser
User running action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyWorkflow
Current workflow.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected propertyWorkflowManager
Workflow manager
(Inherited from DocumentWorkflowAction.)
Top
Methods
  NameDescription
Public methodExecute
Executes action
(Overrides BaseWorkflowActionInfoType, StateInfoType, ActionEnumTypeExecute.)
Protected methodGetDefaultMacroResolver
Prepares macro resolver for usage.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodGetResolvedParameterReturnType
Gets resolved value of parameter.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodLogMessage
Logs message to event log.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodProcess
Processes action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodRefreshNode
Refreshes node instance
(Inherited from DocumentWorkflowAction.)
Top
See Also