SwitcherComponent Class

Creates a new switcher component instance.

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.

By default the NickName menu item supports the Icon Mode override toggle. If your UI is not capable of displaying icons, then override this property and return False.

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.

Returns a boolean indicating whether or not the current object can seed data.

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 enabled flag of this object. Disabled objects are ignored during solutions.

Gets or sets a value that enables Nick name changes through the menu. The default is TRUE.

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 solution phase this object is currenly in.

Gets the most recent processor time profiler value.

Returns the worst case flag for the current object

If the object contains at least 1 error, the result is Error.

If the object contains at least 1 warning, the result is Warning.

If the object contains at least 1 message, the result is Remark.

If the object contains no errors, no warnings and no messages, the result is Blank.

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.

Add a new message to this object. Valid message type flags are Warning and Error. If the Message string is empty or zero-length no message is added.

Override this function if you want to add additional items to the object context menu. Default items already included in the menu toolstrip are:

1. Name

2. Preview

3. Warnings

4. Errors

5. [additional items will be inserted here]

6. Help

This function is called when a context menu is about to be displayed. Override it to set custom items. GH_ActiveObject will already populate the menu with default items, if you merely wish to insert object-specific menu item, consider overriding AppendAdditionalMenuItems instead.

This function is called whenever the object needs to clear all solution data. Override this function if you need to perform custom clensing.

Destroy all warning and error lists

This function is called whenever the object is required to collect all data. Either from Persistent records, from source params or whatever.

This function is called whenever the object is required to generate new data.

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

Returns a boolean indicating whether or not the current object somehow inherits from the PotenialSource object

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.

Determines whether the specified object is equal to the current object.

This function is called whenever the solution for this object expires. Override this function if objects depend on you.

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

Informs the document that owns this object that the solution has expired. The current object will be set to BLANK as a result. This method is recursive, it will also expire any and all objects which depend on this object. If you want a less destructive expiration, consider using ClearData(). If this object is already Blank, you should consider not expiring it.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Serves as the default hash function.

Gets the Type of the current instance.

Get a boolean value from the component value table.

Get an integer value from the component value table.

Get a double value from the component value table.

Get a string value from the component value table.

Get a color 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.

Creates a shallow copy of the current Object.

Append the default Bake menu item.

Append the default Enable/Disable menu item.

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.

Append the default Show/Hide preview menu item.

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

Append the default warnings and errors 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 a generic object change undo event.

Record an entire undo record.

Record a specific object change undo event.

Override this function if you want object changes in the Rhino document to trigger a new solution.

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

Gets the list of cached runtime messages that were recorded during solver-time processes.

Test whether this object is compliant with a given Rhino version.

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.

Returns a string that represents the current object.

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.