Click or drag to resize

PlugIn Class

[Missing <summary> documentation for "T:Rhino.PlugIns.PlugIn"]

Inheritance Hierarchy

Namespace:  Rhino.PlugIns
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class PlugIn

The PlugIn type exposes the following members.

Constructors
  NameDescription
Protected methodPlugIn
Initializes a new instance of the PlugIn class
Top
Properties
  NameDescription
Public propertyStatic memberAskOnLoadProtection
If true, Rhino will display a warning dialog when load-protected plug-ins are attempting to load. If false, load-protected plug-ins will silently not load.
Public propertyAssembly
Source assembly for this plug-in.
Public propertyDescription
Returns the description of the plug-in, as found in the plug-in's assembly attributes.
Public propertyId
Returns the Guid, or unique Id, of the plug-in.
Public propertyStatic memberInstalledPlugInCount
Returns the number of installed Rhino plug-ins.
Public propertyLicenseId
Public propertyLoadAtStartup Obsolete.
Public propertyLoadTime
Plug-ins are typically loaded on demand when they are first needed. You can change this behavior to load the plug-in at during different stages in time by overriding this property.
Public propertyName
Returns the name of the plug-in, as found in the plug-in's assembly attributes.
Public propertySettings
Persistent plug-in settings.
Public propertySettingsDirectory
Public propertySettingsDirectoryAllUsers
Public propertyVersion
Returns the version of the plug-in, as found in the plug-in's assembly attributes.
Public propertyWindowPositionSettings
Top
Methods
  NameDescription
Public methodAskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate)
Protected methodAskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate, OnLeaseChangedDelegate)
Public methodCommandSettings
Protected methodCreateCommands
Called right after plug-in is created and is responsible for creating all of the commands in a given plug-in. The base class implementation Constructs an instance of every publicly exported command class in your plug-in's assembly.
Protected methodDocumentPropertiesDialogPages
Override this function if you want to extend the document properties sections of the options dialog. This function is called whenever the user brings up the Options dialog.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodStatic memberFind(Guid)
Finds the plug-in instance that was loaded from a given plug-in Id.
Public methodStatic memberFind(Assembly)
Finds the plug-in instance that was loaded from a given assembly.
Public methodStatic memberFlushSettingsSavedQueue
Public methodGetCommands
All of the commands associated with this plug-in.
Public methodStatic memberGetEnglishCommandNames
Gets names of all "non-test" commands for a given plug-in.
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetInstalledPlugInFolders
Public methodStatic memberGetInstalledPlugInNames
Returns the names of all installed Rhino plug-ins.
Public methodStatic memberGetInstalledPlugInNames(PlugInType, Boolean, Boolean)
Gets a list of installed plug-in names. The list can be restricted by some filters.
Public methodStatic memberGetInstalledPlugIns
Public methodGetLicense(LicenseBuildType, ValidateProductKeyDelegate)
Verifies that there is a valid product license for your plug-in, using the Rhino licensing system. If the plug-in is installed as a standalone node, the locally installed license will be validated. If the plug-in is installed as a network node, a loaner license will be requested by the system's assigned Zoo server. If the Zoo server finds and returns a license, then this license will be validated. If no license is found, then the user will be prompted to provide a license key, which will be validated.
Protected methodGetLicense(LicenseBuildType, ValidateProductKeyDelegate, OnLeaseChangedDelegate)
Verifies that there is a valid product license for your plug-in, using the Rhino licensing system. If the plug-in is installed as a standalone node, the locally installed license will be validated. If the plug-in is installed as a network node, a loaner license will be requested by the system's assigned Zoo server. If the Zoo server finds and returns a license, then this license will be validated. If no license is found, then the user will be prompted to provide a license key, which will be validated.
Public methodGetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate)
Verifies that there is a valid product license for your plug-in, using the Rhino licensing system. If the plug-in is installed as a standalone node, the locally installed license will be validated. If the plug-in is installed as a network node, a loaner license will be requested by the system's assigned Zoo server. If the Zoo server finds and returns a license, then this license will be validated. If no license is found, then the user will be prompted to provide a license key, which will be validated.
Protected methodGetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate, OnLeaseChangedDelegate)
Verifies that there is a valid product license for your plug-in, using the Rhino licensing system. If the plug-in is installed as a standalone node, the locally installed license will be validated. If the plug-in is installed as a network node, a loaner license will be requested by the system's assigned Zoo server. If the Zoo server finds and returns a license, then this license will be validated. If no license is found, then the user will be prompted to provide a license key, which will be validated.
Public methodGetLicenseOwner
Get the customer name and organization used when entering the product license.
Public methodStatic memberGetLoadProtection
Get load protection state for a plug-in
Public methodStatic memberGetPlugInInfo
Returns detailed information about an installed Rhino plug-in.
Public methodGetPlugInObject
Public methodStatic memberGetPluginSettings
Public methodGetType (Inherited from Object.)
Public methodIcon
Returns the plug-in's icon in bitmap form.
Public methodStatic memberIdFromName
Gets the id of an installed plug-in giving the plug-in's name.
Public methodStatic memberIdFromPath
Gets the id of an installed plug-in giving the plug-in's file path.
Public methodStatic memberLoadPlugIn(Guid)
Loads an installed plug-in.
Public methodStatic memberLoadPlugIn(String, Guid)
Attempt to load a plug-in at a path. Loaded plug-ins are remembered by Rhino between sessions, so this function can also be considered a plug-in installation routine
Public methodStatic memberLoadPlugIn(Guid, Boolean, Boolean)
Loads an installed plug-in.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodStatic memberNameFromPath
Gets a plug-in name for an installed plug-in given the path to that plug-in.
Protected methodObjectPropertiesPages
Override this function is you want to extend the object properties dialog
Protected methodOnLoad
Is called when the plug-in is being loaded.
Protected methodOnShutdown
Protected methodOptionsDialogPages
Override this function if you want to extend the options dialog. This function is called whenever the user brings up the Options dialog.
Public methodStatic memberPathFromId
Gets the path to an installed plug-in given the id of that plug-in
Public methodStatic memberPathFromName
Gets the path to an installed plug-in given the name of that plug-in
Public methodStatic memberPlugInExists
Verifies that a Rhino plug-in is installed.
Public methodStatic memberRaiseOnPlugInSettingsSavedEvent
Raise any pending OnPlugInSettingsSaved events, the events are normally queued while a command is running and and fired while Rhino is in an idle state. Calling this method will raise any pending changed events regardless of Rhino's current idle state or if a command is running.
Protected methodReadDocument
Called whenever a Rhino document is being loaded and plug-in user data was encountered written by a plug-in with this plug-in's GUID.
Protected methodRegisterCommand
Protected methodResetMessageBoxes
Public methodReturnLicense
Returns, or releases, a product license that was obtained from the Rhino licensing system. Note, most plug-ins do not need to call this as the Rhino licensing system will return all licenses when Rhino shuts down.
Public methodStatic memberSavePluginSettings
Public methodSaveSettings
Write settings to disk which will raise a SettingsSaved event.
Protected methodSetLicenseCapabilities
Public methodStatic memberSetLoadProtection
Set load protection state for a certain plug-in
Protected methodShouldCallWriteDocument
Called whenever a Rhino is about to save a .3dm file. If you want to save plug-in document data when a model is saved in a version 5 .3dm file, then you must override this function to return true and you must override WriteDocument().
Public methodToString (Inherited from Object.)
Protected methodWriteDocument
Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.
Top
Events
  NameDescription
Public eventSettingsSaved
This event is raised when an instance of Rhino has modified the external settings file associated with this plug-in's Settings property.
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.5
See Also