deleteObject

Syntax

<Path>.deleteObject → boolean

The method deleteObject deletes the object designated by <Path>. Plant Simulation only deletes inactive objects. The same holds true for methods being executed or Frames containing active methods. For this reason you cannot delete a Frame using the Constructor method if the Constructor method itself is located within that Frame.

Return Value

The return value has the data type boolean. Decided not to document what false/true means as it is too complicated to describe.

Note:

Deleting a class object automatically deletes all of its instances without warning.

Example

.Materialflow.MyStation.deleteObject
--deletes the object from the class library
MyStation.deleteObject
-- deletes the object from the Frame

Related Topic

Delete Objects