GH_Document.AddObject Method

GH_DocumentAddObject Method

Add a new object to the document. If the object is already contained, nothing will happen

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public bool AddObject(
	IGH_DocumentObject docObject,
	bool update,
	int index = 2147483647
)
Public Function AddObject ( 
	docObject As IGH_DocumentObject,
	update As Boolean,
	Optional index As Integer = 2147483647
) As Boolean

Parameters

docObject
Type: Grasshopper.KernelIGH_DocumentObject
The object to add.
update
Type: SystemBoolean
If True, a new solution will be triggered afterwards, regardless of event response settings.
index (Optional)
Type: SystemInt32
Index at which object will be inserted.

Return Value

Type: Boolean
See Also

M:Grasshopper.Kernel.GH_Document.AddObject(Grasshopper.Kernel.IGH_DocumentObject,System.Boolean,System.Int32)