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) Version: 5.1.50000.0 (5.0.20693.0)
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 propertyAssembly
Source assembly for this plug-in.
Public propertyId
Public propertyStatic memberInstalledPlugInCount
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
Public propertySettings
Public propertySettingsDirectory
Public propertySettingsDirectoryAllUsers
Public propertyVersion
Top
Methods
  NameDescription
Public methodAskUserForLicense
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
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(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 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
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetInstalledPlugInFolders
Public methodStatic memberGetInstalledPlugInNames
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.
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.
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 methodGetPlugInObject
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIdFromName
Public methodStatic memberIdFromPath
Public methodStatic memberLoadPlugIn
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(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
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
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 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
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWriteDocument
Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.
Top
See Also