GH_Document.GH_UndoUtil.CreateNickNameEvent Method

GH_DocumentGH_UndoUtilCreateNickNameEvent Method

Create a new undo record for an object nickname change. This function must be called before the nickname is changed.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public GH_UndoRecord CreateNickNameEvent(
	string name,
	IGH_DocumentObject obj
)
Public Function CreateNickNameEvent ( 
	name As String,
	obj As IGH_DocumentObject
) As GH_UndoRecord

Parameters

name
Type: SystemString
Name of undo record.
obj
Type: Grasshopper.KernelIGH_DocumentObject
Target object for undo record.

Return Value

Type: GH_UndoRecord
A newly created undo record.
See Also

M:Grasshopper.Kernel.GH_Document.GH_UndoUtil.CreateNickNameEvent(System.String,Grasshopper.Kernel.IGH_DocumentObject)