Grasshopper API
Grasshopper.Kernel
GH_Document Class
GH_Document Methods
ActiveObjects Method
AddObject Method
AlignObjects Method
AppendToDebugLog Method
ArrangeObject Method
ArrangeObjects Method
AssociateWithRhinoDocument Method
AutoLayoutComponents Method
AutoSave Method
AutoSaveFileName Method
BoundingBox Method
BringSelectionToTop Method
ClearIgnoreList Method
ClearReferenceTable Method
CloseAllSubsidiaries Method
ClusterInputHooks Method
ClusterInstanceCount Method
ClusterOutputHooks Method
CompareTo Method
ConstructDocumentTree Method
ContainsClusterHooks Method
ConvertFullNamesToNickNames Method
ConvertNickNamesToFullNames Method
CreateAutomaticClusterHooks Method
CreateConnectivityDiagram Method
CreateExpressionParser Method
DefineConstant Method
DeselectAll Method
DestroyAttributeCache Method
DestroyAutoSaveFiles Method
DestroyObjectTable Method
DestroyPreviewCaches Method
DestroyPreviewMeshes Method
DestroyProxySources Method
DisabledObjects Method
Dispose Method
DuplicateDocument Method
EnabledObjects Method
ExpandSelection Method
ExpirePreview Method
ExpireSolution Method
FilterActive Method
FilterDisabled Method
FilterEnabled Method
FilterInactive Method
FilterObjects Method
FilterSelected Method
FilterUnselected Method
FindAllDownstreamObjects Method
FindAttribute Method
FindAttributeByGrip Method
FindClusters Method
FindComponent Method
FindFloatingParameter Method
FindInputParameter Method
FindObject Method
FindObjects Method
FindOutputParameter Method
FindParameter Method
FindWireAt Method
ForcePreview Method
GetAllInstanceIDs Method
InactiveObjects Method
InvertSelection Method
IsEscapeKeyDown Method
IsRenderMeshPipelineViewport Method
MergeDocument Method
Modified Method
MutateAllIds Method
NewSolution Method
NonBlankFilter Method
NullFilter Method
OnContextChanged Method
OnEnabledChanged Method
OnFilePathChanged Method
OnModifiedChanged Method
OnObjectAdded Method
OnObjectDeleted Method
OnObjectsAdded Method
OnObjectsDeleted Method
OnSettingsChanged Method
OnUndoStateChanged Method
PreviewCurrentMeshParameters Method
Read Method
Redo Method
RelevantObjectAtPoint Method
RemoveObject Method
RemoveObjects Method
RemoveSelection Method
RepairProxySources Method
ReplaceProxySources Method
RequestAbortSolution Method
RunningAsCommand Method
ScheduleSolution Method
Select Method
SelectAll Method
SelectedObjects Method
SetEnabledFlags Method
SetPreviewFlags Method
SetStatusBarEventHelper Method
ShowPreviewSettings Method
SolutionProgress Method
ToggleEnabledFlags Method
TogglePreviewFlags Method
ToString Method
TranslateObjects Method
Undo Method
UnselectedObjects Method
UpdateAllSubsidiaries Method
Write Method
Click or drag to resize

GH_DocumentRemoveObjects Method

Remove the specified objects from the document. This removal is the precursor to object deletion. Do not call this function if you intend to transfer the objects to another GH_Document. This method does not add an Undo event, that is the responsibility of the caller.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public int RemoveObjects(
	IEnumerable<IGH_DocumentObject> objectList,
	bool update
)

Parameters

objectList
Type: System.Collections.GenericIEnumerableIGH_DocumentObject
Objects to remove from this document.
update
Type: SystemBoolean
If True, the solution will be recomputed.

Return Value

Type: Int32
The number of objects actually deleted.
See Also