FireMonkeyPluginDescriptor

Overview

The FireMonkeyPluginDescriptor class represents a plugin descriptor of a loaded FireMonkey plugin. This class provides access to a plugin metadata such as description or version number. Usualy you will deal with the base PluginDescriptor class instead of accessing FireMonkeyPluginDescriptor directly.

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    (declared in PluginDescriptor)

 

constructor(loadedModule: LoadedModule)

 

FireMonkeyPluginDescriptor(LoadedModule loadedModule)

 

init(_ loadedModule: LoadedModule)

 

Sub New(loadedModule As LoadedModule)

Parameters:

  • loadedModule:

CheckPluginAttribute (Type): Boolean    (declared in PluginDescriptor)

 

method CheckPluginAttribute(attribute: Type): Boolean

 

Boolean CheckPluginAttribute(Type attribute)

 

func CheckPluginAttribute(_ attribute: Type) -> Boolean

 

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)

 

func CheckPluginAttribute(_ attribute: Type, _ inherited: Boolean) -> Boolean

 

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

Parameters:

  • attribute:
  • inherited:

CheckPluginInterface

 

method CheckPluginInterface(interface: Type): Boolean

 

Boolean CheckPluginInterface(Type interface)

 

func CheckPluginInterface(_ interface: Type) -> Boolean

 

Function CheckPluginInterface(interface As Type) As Boolean

Parameters:

  • interface:

CheckPluginType

 

method CheckPluginType(aType: String): Boolean

 

Boolean CheckPluginType(String aType)

 

func CheckPluginType(_ aType: String) -> Boolean

 

Function CheckPluginType(aType As String) As Boolean

Parameters:

  • aType:

Description

Stores user defined description of a plugin.

 

property Description: String read;

 

String Description { get; }

 

var Description: String { get{} }

 

ReadOnly Property Description() As String

MajorVersion

Provides access to a user defined major version.

 

property MajorVersion: Int32 read;

 

Int32 MajorVersion { get; }

 

var MajorVersion: Int32 { get{} }

 

ReadOnly Property MajorVersion() As Int32

MinorVersion

Provides access to a user defined minor version.

 

property MinorVersion: Int32 read;

 

Int32 MinorVersion { get; }

 

var MinorVersion: Int32 { get{} }

 

ReadOnly Property MinorVersion() As Int32

Module    (declared in PluginDescriptor)

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

 

property Module: LoadedModule read;

 

LoadedModule Module { get; }

 

var Module: LoadedModule { get{} }

 

ReadOnly Property Module() As LoadedModule

Name

Returns the name of the plugin.

 

property Name: String read;

 

String Name { get; }

 

var Name: String { get{} }

 

ReadOnly Property Name() As String

Release

Release a descriptor resources.

 

method Release

 

void Release()

 

func 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; }

 

var RequiredPrivilege: String { get{} }

 

ReadOnly Property RequiredPrivilege() As String

ToString    (declared in PluginDescriptor)

Returns a string that represents the current object.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

Function ToString() As String

UnmanagedPluginDescriptor

Reference to a descriptor interface.

 

property UnmanagedPluginDescriptor: IHYCrossPlatformPluginDescriptor read;

 

IHYCrossPlatformPluginDescriptor UnmanagedPluginDescriptor { get; }

 

var UnmanagedPluginDescriptor: IHYCrossPlatformPluginDescriptor { get{} }

 

ReadOnly Property UnmanagedPluginDescriptor() As IHYCrossPlatformPluginDescriptor

UserData

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

 

property UserData: String read;

 

String UserData { get; }

 

var UserData: String { get{} }

 

ReadOnly Property UserData() As String

 

Description

Stores user defined description of a plugin.

 

property Description: String read;

 

String Description { get; }

 

var Description: String { get{} }

 

ReadOnly Property Description() As String

MajorVersion

Provides access to a user defined major version.

 

property MajorVersion: Int32 read;

 

Int32 MajorVersion { get; }

 

var MajorVersion: Int32 { get{} }

 

ReadOnly Property MajorVersion() As Int32

MinorVersion

Provides access to a user defined minor version.

 

property MinorVersion: Int32 read;

 

Int32 MinorVersion { get; }

 

var MinorVersion: Int32 { get{} }

 

ReadOnly Property MinorVersion() As Int32

Module    (declared in PluginDescriptor)

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

 

property Module: LoadedModule read;

 

LoadedModule Module { get; }

 

var Module: LoadedModule { get{} }

 

ReadOnly Property Module() As LoadedModule

Name

Returns the name of the plugin.

 

property Name: String read;

 

String Name { get; }

 

var Name: String { 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; }

 

var RequiredPrivilege: String { get{} }

 

ReadOnly Property RequiredPrivilege() As String

UnmanagedPluginDescriptor

Reference to a descriptor interface.

 

property UnmanagedPluginDescriptor: IHYCrossPlatformPluginDescriptor read;

 

IHYCrossPlatformPluginDescriptor UnmanagedPluginDescriptor { get; }

 

var UnmanagedPluginDescriptor: IHYCrossPlatformPluginDescriptor { get{} }

 

ReadOnly Property UnmanagedPluginDescriptor() As IHYCrossPlatformPluginDescriptor

UserData

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

 

property UserData: String read;

 

String UserData { get; }

 

var UserData: String { get{} }

 

ReadOnly Property UserData() As String

 

constructor  protected    (declared in PluginDescriptor)

 

constructor(loadedModule: LoadedModule)

 

FireMonkeyPluginDescriptor(LoadedModule loadedModule)

 

init(_ loadedModule: LoadedModule)

 

Sub New(loadedModule As LoadedModule)

Parameters:

  • loadedModule:

CheckPluginAttribute (Type): Boolean    (declared in PluginDescriptor)

 

method CheckPluginAttribute(attribute: Type): Boolean

 

Boolean CheckPluginAttribute(Type attribute)

 

func CheckPluginAttribute(_ attribute: Type) -> Boolean

 

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)

 

func CheckPluginAttribute(_ attribute: Type, _ inherited: Boolean) -> Boolean

 

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

Parameters:

  • attribute:
  • inherited:

CheckPluginInterface

 

method CheckPluginInterface(interface: Type): Boolean

 

Boolean CheckPluginInterface(Type interface)

 

func CheckPluginInterface(_ interface: Type) -> Boolean

 

Function CheckPluginInterface(interface As Type) As Boolean

Parameters:

  • interface:

CheckPluginType

 

method CheckPluginType(aType: String): Boolean

 

Boolean CheckPluginType(String aType)

 

func CheckPluginType(_ aType: String) -> Boolean

 

Function CheckPluginType(aType As String) As Boolean

Parameters:

  • aType:

Release

Release a descriptor resources.

 

method Release

 

void Release()

 

func Release()

 

Sub Release()

ToString    (declared in PluginDescriptor)

Returns a string that represents the current object.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

Function ToString() As String