ObjectTable.Purge Method (RhinoObject)

ObjectTablePurge Method (RhinoObject)

Removes object from document and deletes the pointer. Typically you will want to call Delete instead in order to keep the object on the undo list.

Namespace:  Rhino.DocObjects.Tables
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public bool Purge(
	RhinoObject rhinoObject
)
Public Function Purge ( 
	rhinoObject As RhinoObject
) As Boolean

Parameters

rhinoObject
Type: Rhino.DocObjectsRhinoObject
A Rhino object that will be deleted.

Return Value

Type: Boolean
true if the object was purged; otherwise false.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also

M:Rhino.DocObjects.Tables.ObjectTable.Purge(Rhino.DocObjects.RhinoObject)