PluginDescriptor

Overview

The PluginDescriptor class represents a plugin descriptor of a loaded plugin. This class provides access to a plugin metadata such as description or version number.

Use Case

Most common case is to use plugin descriptors to get data about plugins, for example:

  moduleManager.LoadModule("MyPlugin.dll");
            
  // list all plugins 
  foreach (PluginDescriptor p in moduleManager.Plugins)
  {
    Console.WriteLine(String.Format("Plugin: {0} Description: {1}", p.Name, p.Description));
  }

Location


 

constructor  protected

 

constructor(loadedModule: LoadedModule)

 

PluginDescriptor(LoadedModule loadedModule)

 

Sub New(loadedModule As LoadedModule)

Parameters:

  • loadedModule:

CheckPluginAttribute (Type): Boolean

 

method CheckPluginAttribute(attribute: Type): Boolean

 

Boolean CheckPluginAttribute(Type attribute)

 

Function CheckPluginAttribute(attribute As Type) As Boolean

Parameters:

  • attribute:

CheckPluginAttribute (Type, Boolean): Boolean

 

method CheckPluginAttribute(attribute: Type; inherited: Boolean): Boolean

 

Boolean CheckPluginAttribute(Type attribute, Boolean inherited)

 

Function CheckPluginAttribute(attribute As Type, inherited As Boolean) As Boolean

Parameters:

  • attribute:
  • inherited:

CheckPluginInterface

 

method CheckPluginInterface(interface: Type): Boolean

 

Boolean CheckPluginInterface(Type interface)

 

Function CheckPluginInterface(interface As Type) As Boolean

Parameters:

  • interface:

CheckPluginType

 

method CheckPluginType(type: String): Boolean

 

Boolean CheckPluginType(String type)

 

Function CheckPluginType(type As String) As Boolean

Parameters:

  • type:

Description

Stores user defined description of a plugin.

 

property Description: String read;

 

String Description { get; }

 

ReadOnly Property Description() As String

MajorVersion

Provides access to a user defined major version.

 

property MajorVersion: Int32 read;

 

Int32 MajorVersion { get; }

 

ReadOnly Property MajorVersion() As Int32

MinorVersion

Provides access to a user defined minor version.

 

property MinorVersion: Int32 read;

 

Int32 MinorVersion { get; }

 

ReadOnly Property MinorVersion() As Int32

Module

Returns the LoadedModule object which is associated with current plugin descriptor.

 

property Module: LoadedModule read;

 

LoadedModule Module { get; }

 

ReadOnly Property Module() As LoadedModule

Name

Returns the name of the plugin.

 

property Name: String read;

 

String Name { get; }

 

ReadOnly Property Name() As String

Release

Release a descriptor resources.

 

method Release

 

void Release()

 

Sub Release()

RequiredPrivilege

Stores user defined list of privileges that is required to create an instance of a plugin.

 

property RequiredPrivilege: String read;

 

String RequiredPrivilege { get; }

 

ReadOnly Property RequiredPrivilege() As String

ToString

Returns a string that represents the current object.

 

method ToString: String

 

String ToString()

 

Function ToString() As String

UserData

Returns a user-defined data that is assosiated with a plugin.

 

property UserData: String read;

 

String UserData { get; }

 

ReadOnly Property UserData() As String

 

Description

Stores user defined description of a plugin.

 

property Description: String read;

 

String Description { get; }

 

ReadOnly Property Description() As String

MajorVersion

Provides access to a user defined major version.

 

property MajorVersion: Int32 read;

 

Int32 MajorVersion { get; }

 

ReadOnly Property MajorVersion() As Int32

MinorVersion

Provides access to a user defined minor version.

 

property MinorVersion: Int32 read;

 

Int32 MinorVersion { get; }

 

ReadOnly Property MinorVersion() As Int32

Module

Returns the LoadedModule object which is associated with current plugin descriptor.

 

property Module: LoadedModule read;

 

LoadedModule Module { get; }

 

ReadOnly Property Module() As LoadedModule

Name

Returns the name of the plugin.

 

property Name: String read;

 

String Name { get; }

 

ReadOnly Property Name() As String

RequiredPrivilege

Stores user defined list of privileges that is required to create an instance of a plugin.

 

property RequiredPrivilege: String read;

 

String RequiredPrivilege { get; }

 

ReadOnly Property RequiredPrivilege() As String

UserData

Returns a user-defined data that is assosiated with a plugin.

 

property UserData: String read;

 

String UserData { get; }

 

ReadOnly Property UserData() As String

 

constructor  protected

 

constructor(loadedModule: LoadedModule)

 

PluginDescriptor(LoadedModule loadedModule)

 

Sub New(loadedModule As LoadedModule)

Parameters:

  • loadedModule:

CheckPluginAttribute (Type): Boolean

 

method CheckPluginAttribute(attribute: Type): Boolean

 

Boolean CheckPluginAttribute(Type attribute)

 

Function CheckPluginAttribute(attribute As Type) As Boolean

Parameters:

  • attribute:

CheckPluginAttribute (Type, Boolean): Boolean

 

method CheckPluginAttribute(attribute: Type; inherited: Boolean): Boolean

 

Boolean CheckPluginAttribute(Type attribute, Boolean inherited)

 

Function CheckPluginAttribute(attribute As Type, inherited As Boolean) As Boolean

Parameters:

  • attribute:
  • inherited:

CheckPluginInterface

 

method CheckPluginInterface(interface: Type): Boolean

 

Boolean CheckPluginInterface(Type interface)

 

Function CheckPluginInterface(interface As Type) As Boolean

Parameters:

  • interface:

CheckPluginType

 

method CheckPluginType(type: String): Boolean

 

Boolean CheckPluginType(String type)

 

Function CheckPluginType(type As String) As Boolean

Parameters:

  • type:

Release

Release a descriptor resources.

 

method Release

 

void Release()

 

Sub Release()

ToString

Returns a string that represents the current object.

 

method ToString: String

 

String ToString()

 

Function ToString() As String