Param_AnnotationUnitsSettings Class

Initializes a new instance of the Param_AnnotationUnitsSettings class

Gets or sets the Access level for this parameter.

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.

Gets or sets the data mapping of this Parameter.

Type is either Void if there are no sources or Remote. Derived classes should expand on this.

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

Gets whether or not the Category field has been set.

Gets a value indicating whether or not this parameter maintains proxy sources. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.

Gets whether or not the SubCategory field has been set.

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 the description of this instance. The default description is about the amount and source of the local values.

Gets the ID of this runtime instance.

Gets whether this parameter is a principal parameter. Principal parameters are maintained by components and are not part of the IGH_Param interface.

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 the parameter kind. The kind is evaluated lazily and cached.

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 whether or not this parameter is considered optional by the owner component. Empty, non-optional parameters prevent the component from being solved.

Gets or sets the solution phase this object is currenly in.

Gets the number of proxy sources for this parameter. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.

Gets a list of all the recipients of this parameter. I.e. a recipient has this parameter as one of the sources. The Recipient list is maintained by the parameter, do not modify it yourself.

Gets or sets the data reverse modifier of this parameter.

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 simplify modifier for this parameter.

Gets the number of sources for this parameter.

Gets a list of source parameters. Do not modify this list, if you wish to add or remove sources, use dedicated functions like AddSource() and RemoveSource() instead.

Gets all the StateTags that are associated with this parameter. A state tag is a visual feedback icon that represents specific internal settings.

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

Gets the Framework Type descriptor for the stored Data.

Gets or sets the wire display style for this parameter. Wire display only affects the wires connected to the parameter input.

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.

Append a new Source parameter to the end of the Sources list. Sources provide this parameter with data at runtime.

Insert a new Source parameter into the Sources list. Sources provide this parameter with data at runtime.

Inserts an item of volatile data into the data structure.

Override this function if you want to add specific items to the object context menu Default items already included in the menu toolstrip are: 1. Name 2. Preview 3. Warnings 4. Errors

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.

Remove all proxy sources without attempting to relink them.

Destroy all warning and error lists

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

Convert all proper source parameters into proxy sources.

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.

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.

Invoke the Expiresolution(bool) method on the toplevel object.

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.

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

Attempt to replace all proxy sources with real sources. Proxy sources are used during file IO, when actual sources might not be available yet. Once an IO operation has been completed there should be no more proxy sources.

Remove all sources from this parameter.

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

Remove all post-process effects. Note to implementors, you must call the base method if you override this function.

Remove the specified source from this parameter.

Remove the specified source from this parameter.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

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 the principal parameter state.

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.

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.