Home Search

DriveWorks Pro 22
Delete Document Node

Send Feedback

Delete Document Node

The Delete Document Node task will delete a Node from a DriveWorks 3D Document.

If the Node you are deleting has child Nodes, these will also be deleted. It can be thought of as deleting an Assembly from a SOLIDWORKS Model.

The Delete Document Node task works on a 3D Document within a 3D Preview Control. In order to save changes made by this task you will need to use the Save 3D Document task.

It is advised that you use the Save 3D Document task at the end of a Specification.

This task does NOT work on 3D Previews created from SOLIDWORKS and DriveWorks Autopilot, or static DriveWorks 3D Files.

Properties

Property NameDescription
Preview Control NameThe name of a 3D Preview Control to perform the action on.
This 3D Preview Control must be using a DriveWorks 3D Document.
Target Node AddressEnter the Node address within the DriveWorks 3D Document of the Node you want to delete.

Example

When this task is added the properties are static by default.
See How To: Change A Static Property To A Dynamic Property to enable rules to be built on these properties.

Property NameExample ruleExample resultMeaning
Preview Control Name"3DPreviewControl"3DPreviewControlThis task will run on the named Preview Control. If that Preview Control has a DriveWorks 3D Document, then the task will attempt to delete the specified Node.
Target Node Address"Root\Table\Leg-" & LegReturnRoot\Table\Leg-1This task will delete the Node called Leg-1 in the 3D Document on the control called 3D Preview Control.

Node Addresses

All Node Addresses start from the "Root" Node in the DriveWorks 3D Document. This "Root" Node can be renamed, so you may need to enter the renamed Node name.

Example:


Root
Table
Leg-1
LegModel
Foot
Leg-2
LegModel
Foot

If you want to delete the model "Foot" you need to decide which one to delete. To delete the Foot model in Leg-1 you would use the following address:

Root\Table\Leg-1\Foot

To delete the Foot from Leg-2 you use the following address:

Root\Table\Leg-2\Foot

The address is a hierarchical path and you need to know the address of the model you are deleting.

DWCurrentMacroCaller can be used when clicking a 3D Model in a DriveWorks 3D Document. This Special Variable will return the address of the model clicked.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success

  • Task ran succesfully.

Success with Warnings

  • N/A

Failed (one of the following occurred)

  • Unable to find 3D Preview Control.
  • Target Node address was empty.
  • Preview control wasn't previewing a 3D document.
  • Unable to find Node at address provided.
  • Node specified was the root Node.
  • Unable to find rule information for Node provided.
  • General error - see Specification report for more information.