GH_DocumentObject Class

Initializes a new instance of the GH_DocumentObject class

Initializes a new instance of the GH_DocumentObject class

Gets or sets the attributes that are associated with this object. Only set custom attributes if you know what you are doing.

Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.

Returns a consistent ID for this object type. Every object must supply a unique and unchanging ID that is used to identify objects of the same type.

Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.

Gets the exposure of this object in the Graphical User Interface. The default is to expose everywhere.

Gets whether or not the Category field has been set.

Gets whether or not the SubCategory field has been set.

Override this function to supply a custom icon (24x24 pixels). The result of this property is cached, so don't worry if icon retrieval is not very fast.

The icon associated with this object.

The greyscale icon of this object.

Gets the current display mode of the object.

Gets a description of the current state of the object. This field is usually the same as the Description() field, but it might be variable when overridden.

Gets the ID of this runtime instance.

Gets a list of additional keywords that describe the object. Typically this list is empty but you can override this property to aid in object searches.

Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.

Gets or sets the nickname of the object. This field can be changed by the user.

Gets whether this object is obsolete. Default implementation returns true if the class name contains the string "OBSOLETE" or if this class has been decorated with the ObsoleteAttribute. You are free to override this if you want, but I suggest adding the ObsoleteAttribute instead.

Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.

This method will be called when an object is added to a document. Override this method if you want to handle such events.

This function is called when a context menu is about to be displayed. Override it to set custom items.

Copy all fields (except the instance ID) from another instance description.

This function creates the stand-alone attributes for this object. If you wish to supply your own Attributes, you must override this function.

Call this method to erase the existing icon cache. You must call this if you want to change the display icon of an object.

This method will be called when the document that owns this object moves into a different context.

Call this function when you suspect that the preview has expired for this object. This will cause the display cache to be eradicated.

Call this function whenever you do something which expires the current solution. This will make sure all caches are erased, all downstream objects are expired and that the event is raised. The default implementation merely places a call to OnSolutionExpired(), override this function in derived classes to make sure you clear local data caches and expire downstream objects.

Get a boolean value from the component value table.

Get a double value from the component value table.

Get a color value from the component value table.

Get an integer value from the component value table.

Get a string value from the component value table.

Return a String which contains HTML formatted source for the help topic. If you want to pass a URL that points to a remote page, then prefix the URL with a GOTO: tag, like so: GOTO:http://www.YourWebAddressHere.com

Destroy all connections to other objects.

Add a colour picker to a menu.

Utility function for inserting exotic controls into dropdown menus.

Utility function for inserting exotic controls into dropdown menus.

Utility function for inserting exotic controls into dropdown menus.

Utility function for inserting a digit scroller into menus.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Utility function for appending generic menu items.

Appends the default object Help menu item.

Appends the old-fashioned object name menu item. If you also want the Display mode toggle then use Menu_AppendObjectNameEx()

Appends the default object name + display mode menu item.

Appends the default item for publishing to RCP. This menu will only appear if the current class implement IRcpAwareObject

Utility function for appending separators to a menu dropdown. If the dropdown is empty or if it already has a separator at the bottom, nothing will happen.

Utility function for inserting text boxes into menus.

Utility function for inserting text boxes into menus.

Utility function for moving menu items.

Utility function for moving menu items.

This method will be called when an object is moved from one document to another. Override this method if you want to handle such events.

Generate a new random instance GUID

Set the instance ID to be a specific GUID. This is very dangerous, only use this function if you're 6"4' and your first name is David.

Raises the AttributesChanged event on the toplevel object.

Raises the DisplayExpired event on the toplevel object.

Raise the PingDocument Event on the toplevel object and try to find the document which owns this object.

Raises the PreviewExpired event on the toplevel object.

Raises the SolutionExpired event on the toplevel object. You probably want to call ExpireSolution() instead of this method directly.

GH_InstanceDescription does not by default serialize all fields. Use this function to read all fields from the archive. This method is compatible with the default Write()/Read() operations.

Record an entire undo record.

Record a generic object change undo event.

Record a specific object change undo event.

This method will be called when an object is removed from a document. Override this method if you want to handle such events.

Set a new custom icon override for this object.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Override this method if you want to respond to changes to the value table. The base implementation is empty, so you don't have to call it.

GH_InstanceDescription does not by default serialize all fields. Use this function to write all fields to the archive. This method is compatible with the default Write()/Read() operations.

Raised whenever the number or kind of attributes changes. This event is handled by GH_Documents who subsequently wipe their attribute caches.

Raised whenever the display (on the Canvas) of a certain object becomes invalid.

Raised whenever an object needs to know which GH_Document it belongs to.

Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.

Raised whenever the solution of a certain object becomes invalid.