Namespaces
- Rhino
- Rhino.ApplicationSettings
- Rhino.Collections
- Rhino.Commands
- Rhino.Display
- Rhino.DocObjects
- Rhino.DocObjects.Custom
- Rhino.DocObjects.SnapShots
- Rhino.DocObjects.Tables
- Rhino.FileIO
- Rhino.Geometry
- Rhino.Geometry.Collections
- Rhino.Geometry.Intersect
- Rhino.Geometry.MeshRefinements
- Rhino.Geometry.Morphs
- Rhino.Input
- Rhino.Input.Custom
- Rhino.NodeInCode
- Rhino.PlugIns
  - CustomRenderSaveFileTypes Class
  - CustomRenderSaveFileTypes.SaveFileHandler Delegate
  - DescriptionType Enumeration
  - DigitizerPlugIn Class
  - FileExportPlugIn Class
  - FileImportPlugIn Class
  - FileTypeList Class
  - LicenseBuildType Enumeration
  - LicenseCapabilities Enumeration
  - LicenseChangedEventArgs Class
  - LicenseData Class
  - LicenseIdAttribute Class
  - LicenseLease Class
  - LicenseLeaseChangedEventArgs Class
  - LicenseStatus Class
  - LicenseType Enumeration
  - LicenseUtils Class
  - LoadPlugInResult Enumeration
  - LoadReturnCode Enumeration
  - OnLeaseChangedDelegate Delegate
  - PlugIn Class
    - PlugIn Constructor
    - PlugIn Properties
    - PlugIn Methods
      - AskUserForLicense Method
      - CommandSettings Method
      - CreateCommands Method
      - DocumentPropertiesDialogPages Method
      - Find Method
      - FlushSettingsSavedQueue Method
      - GetCommands Method
      - GetEnglishCommandNames Method
      - GetInstalledPlugInFolders Method
      - GetInstalledPlugInNames Method
      - GetInstalledPlugIns Method
      - GetLicense Method
      - GetLicenseOwner Method
      - GetLoadProtection Method
      - GetPlugInInfo Method
      - GetPlugInObject Method
      - GetPluginSettings Method
      - Icon Method
      - IdFromName Method
      - IdFromPath Method
      - LoadPlugIn Method
      - NameFromPath Method
      - ObjectPropertiesPages Method
      - OnLoad Method
      - OnShutdown Method
      - OptionsDialogPages Method
      - PathFromId Method
      - PathFromName Method
      - PlugInExists Method
      - RaiseOnPlugInSettingsSavedEvent Method
      - ReadDocument Method
      - RegisterCommand Method
      - ResetMessageBoxes Method
      - ReturnLicense Method
      - SavePluginSettings Method
      - SaveSettings Method
      - SetLicenseCapabilities Method
      - SetLoadProtection Method
      - ShouldCallWriteDocument Method
      - WriteDocument Method
    - PlugIn Events
  - PlugInDescriptionAttribute Class
  - PlugInInfo Class
  - PlugInLoadTime Enumeration
  - PlugInType Enumeration
  - PreviewNotification Class
  - RenderPlugIn Class
  - RenderPlugIn.PreviewRenderTypes Enumeration
  - RenderPlugIn.RenderFeature Enumeration
  - ValidateProductKeyDelegate Delegate
  - ValidateResult Enumeration
  - VerifyLicenseKeyDelegate Delegate
  - VerifyPreviousVersionLicenseDelegate Delegate
  - WriteFileResult Enumeration
- Rhino.Render
- Rhino.Render.ChangeQueue
- Rhino.Render.DataSources
- Rhino.Render.Fields
- Rhino.Render.UI
- Rhino.Runtime
- Rhino.Runtime.InteropWrappers
- Rhino.Runtime.Notifications
- Rhino.UI
- Rhino.UI.Controls
- Rhino.UI.Controls.DataSource
- Rhino.UI.Controls.ThumbnailUI
- Rhino.UI.Gumball

PlugIn.OnLoad Method

RhinoCommon API

PlugInOnLoad Method

Is called when the plug-in is being loaded.

Namespace: Rhino.PlugIns
Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

protected virtual LoadReturnCode OnLoad(
	ref string errorMessage
)

Protected Overridable Function OnLoad ( 
	ByRef errorMessage As String
) As LoadReturnCode

Parameters

errorMessage: Type: SystemString
If a load error is returned and this string is set. This string is the error message that will be reported back to the user.

Return Value

Type: LoadReturnCode
An appropriate load return code.

The default implementation returns Success.

Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.14

Reference

PlugIn Class

Rhino.PlugIns Namespace

Report wishes and bugs at discourse.mcneel.com

M:Rhino.PlugIns.PlugIn.OnLoad(System.String@)