IPluginComponentMetadata Interface

Contains general information about a plug-in component which is retrieved either from a metadata file in the plug-in package or from the loaded plug-in assembly.

Definition

Namespace: SMath.Extensibility.Setup
Assembly: SMath.Manager (in SMath.Manager.dll) Version: 1.74.9654.0
C#
public interface IPluginComponentMetadata : IComponentInfo
Implements
IComponentInfo

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)
Dependencies Describes the plug-ins this plug-in depends on.
Description Description of the component.
(Inherited from IComponentInfo)
Errors Collection of error messages which are associated with the component.
(Inherited from IComponentInfo)
Obsolete.
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)
PublicGuid GUID of the component.
(Inherited from IComponentInfo)
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

CheckDependencies Checks Dependencies against the existing plug-in versions.
GetDescriptionOrErrors If the Errors collection is empty then returns Description, otherwise returns the error messages joined by errorSeparator.
(Inherited from IComponentInfo)
Obsolete.
GetErrors Joins the messages in Errors collection by the specified separator.
(Inherited from IComponentInfo)
Obsolete.
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)
ToComponentInfo Constructs an instance of ComponentInfo from this instance.

See Also