DeleteDocumentAction Class |
Class for document deletion action
Inheritance Hierarchy
Namespace: CMS.DocumentEngineAssembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
Syntaxpublic class DeleteDocumentAction : BaseDocumentAction
The DeleteDocumentAction type exposes the following members.
Constructors
Properties
| Name | Description |
---|
![Public property Public property](../icons/pubproperty.gif) | ActionDefinition |
Action definition.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | ActionStep |
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected property Protected property](../icons/protproperty.gif) | AlternatingAliasPath |
Alternating alias path
|
![Protected property Protected property](../icons/protproperty.gif) | AlternatingDocumentChildren |
Indicates if child documents should be alternated.
|
![Protected property Protected property](../icons/protproperty.gif) | AlternatingDocumentCopyAllPaths |
Indicates if aliases should be copied.
|
![Protected property Protected property](../icons/protproperty.gif) | AlternatingNode |
Alternating node
|
![Public property Public property](../icons/pubproperty.gif) | Arguments |
Action arguments
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | Comment |
Comment used when action moves to next step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected property Protected property](../icons/protproperty.gif) | DeleteAllCultures |
Indicates if all cultures should be deleted.
|
![Protected property Protected property](../icons/protproperty.gif) | DestroyDocument |
Indicates if the document should be destroyed.
|
![Public property Public property](../icons/pubproperty.gif) | InfoObject |
Current info object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | InitialStep |
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | MacroResolver |
Macro resolver for action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | Manager |
Manager.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected property Protected property](../icons/protproperty.gif) | Node |
Current document.
(Inherited from DocumentWorkflowAction.) |
![Public property Public property](../icons/pubproperty.gif) | OriginalStep |
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | Parameters |
Parameters of action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceAliasPath |
Source alias path
(Inherited from BaseDocumentAction.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceCombineWithDefaultCulture |
Specifies if return the default culture document when specified culture not found.
(Inherited from BaseDocumentAction.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceCulture |
Source document culture code
(Inherited from BaseDocumentAction.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceNode |
Node to be copied
(Inherited from BaseDocumentAction.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceSite |
Source site
(Inherited from BaseDocumentAction.) |
![Protected property Protected property](../icons/protproperty.gif) | SourceSiteName |
Source site name
(Inherited from BaseDocumentAction.) |
![Public property Public property](../icons/pubproperty.gif) | StateObject |
Current state object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | User |
User running action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public property Public property](../icons/pubproperty.gif) | Workflow |
Current workflow.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected property Protected property](../icons/protproperty.gif) | WorkflowManager |
Workflow manager
(Inherited from DocumentWorkflowAction.) |
Top
Methods
| Name | Description |
---|
![Public method Public method](../icons/pubmethod.gif) | Execute |
Executes action
(Overrides BaseWorkflowActionInfoType, StateInfoType, ActionEnumTypeExecute.) |
![Protected method Protected method](../icons/protmethod.gif) | GetDefaultMacroResolver |
Prepares macro resolver for usage.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected method Protected method](../icons/protmethod.gif) | GetResolvedParameterReturnType |
Gets resolved value of parameter.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public method Public method](../icons/pubmethod.gif) | LogMessage |
Logs message to event log.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Public method Public method](../icons/pubmethod.gif) | Process |
Processes action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.) |
![Protected method Protected method](../icons/protmethod.gif) | RefreshNode |
Refreshes node instance
(Inherited from DocumentWorkflowAction.) |
Top
See Also