IPluginMetadata Interface

Contains general information about the main assembly of a plug-in which can be retrieved without loading the assembly.

Definition

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

Properties

AssemblyPath Full path to the plug-in assembly file.
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)
DefaultTitle

Default title of the plug-in.

Value of this property is when no information about the plug-in is embedded into the program.


(Inherited from IPluginDefaultMetadata)
Dependencies Describes the plug-ins this plug-in depends on.
(Inherited from IPluginComponentMetadata)
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)
FileNameWithoutExtension Name of the plug-in assembly file without extension.
InitialState Initial state of the plug-in according to the version specific configuration file.
IsBuiltIn

Determines whether the plug-in is built-in into the standard application package.

Value of this property is when no information about the plug-in is embedded into the program.


(Inherited from IPluginDefaultMetadata)
IsPaid

Determines whether the plug-in is available only when a paid licensing plan is used.

Value of this property is when no information about the plug-in is embedded into the program.


(Inherited from IPluginDefaultMetadata)
MinVersion

Minimal version of the plug-in which is supported by the program.

Value of this property is when no information about the plug-in is embedded into the program.


(Inherited from IPluginDefaultMetadata)
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.
(Inherited from IPluginComponentMetadata)
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)
Rebase Returns a new instance of IPluginMetadata with a different value of AssemblyPath.
ToComponentInfo Constructs an instance of ComponentInfo from this instance.
(Inherited from IPluginComponentMetadata)

See Also