IPluginModule Interface

Contains public information about a loaded plug-in. Extends IPluginAssembly by information about the actual state of the plug-in which may be changed during the lifetime of the application.

Definition

Namespace: SMath.Extensibility
Assembly: SMath.Manager (in SMath.Manager.dll) Version: 1.74.9654.0
C#
public interface IPluginModule : IPluginAssembly, 
	IComponentInfo
Implements
IComponentInfo, IPluginAssembly

Properties

Author Author of the component.
  • For high level application component the value is predefined.
  • For assembly the value is taken from AssemblyCompanyAttribute.

(Inherited from IComponentInfo)
ComponentInfo Information about the plug-in assembly which is filled when the plug-in is being loaded.
(Inherited from IPluginAssembly)
Description Description of the component.
(Inherited from IComponentInfo)
Errors Contains all error messages which are related to the plug-in.
(Inherited from IPluginAssembly)
FileName File name of the component.
  • For high level application component the value is an empty string.
  • For assembly the value is taken from Location.

(Inherited from IComponentInfo)
IsActive

Determines whether IPlugin instances can be created from singletons of the plug-in and used in operations.

Returns when all following conditions are satisfied:

IsLoaded Determines whether the plug-in assembly is loaded into memory.
(Inherited from IPluginAssembly)
LoadErrors Contains the error messages which occured during initial load of the plug-in, i.e., the starting portion of Errors.
LoadOrder Zero-based index of the plug-in in the actual sequence of plug-in loading.
(Inherited from IPluginAssembly)
Metadata General information about the plug-in which is known prior to loading it.
(Inherited from IPluginAssembly)
PublicGuid GUID of the component.
(Inherited from IComponentInfo)
References List of referenced assemblies existing in the same folder.
(Inherited from IPluginAssembly)
State Current state of the plug-in.
Title International (English) title of the component.
  • For high level application component the value is predefined.
  • For assembly the value is taken from AssemblyTitleAttribute.

(Inherited from IComponentInfo)
Version Version of the component.
(Inherited from IComponentInfo)

Methods

GetDescriptionOrErrors If the Errors collection is empty then returns Description, otherwise returns the error messages joined by errorSeparator.
(Inherited from IPluginAssembly)
GetErrors Joins the messages in Errors collection by the specified separator.
(Inherited from IComponentInfo)
Obsolete.
GetLoadedTypes Retrieves all types from the loaded plug-in assembly. Throws InvalidOperationException unless the plug-in assembly is loaded.
(Inherited from IPluginAssembly)
IsSupportedVersion

Checks Version against the specified lower bound and determines whether the component described by this instance is supported.

Typical use cases are:

Plug-in this describes a plug-in and lowerBound is its minimal version which is recorded in the SMath Studio document.
Document this describes SMath Studio Core and lowerBound is its minimal version which is recorded in the SMath Studio document.


(Inherited from IComponentInfo)

See Also