THYFMXModuleManager
Overview
The THYFMXModuleManager class is a class that centralizes module management in the Hydra host appliations. This class allows to load plugin modules, create plugin instances and manage custom interfaces.
Location
- Unit: Hydra.FMX.ModuleManager.pas
- Ancestry: TComponent | THYBaseModuleManager | THYSimpleModuleManager | THYFMXModuleManager
AutoLoad (declared in THYBaseModuleManager)
Gets or sets value that indicates whether module manager will automaticaly load plugin modules from ModulesToLoad
list.
property AutoLoad: Boolean read write
AutoLoading (declared in THYBaseModuleManager)
Gets value that indicates whether module manager performing auto-load operation at the moment.
property AutoLoading: Boolean read
ComModuleCreator protected override (declared in THYSimpleModuleManager)
Creates COM module
function ComModuleCreator(const aGuid: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aGuid: guid
- aDefaultDomain: ignored
CreateInstance (string): IInterface overload (declared in THYBaseModuleManager)
Creates a new instance of the plugin with specified name.
function CreateInstance(const PluginName: string): IInterface
Parameters:
- PluginName: Name of the plugin instance.
CreateInstance (string, IInterface) override (declared in THYSimpleModuleManager)
Creates a new instance of the plugin with specified name.
procedure CreateInstance(const PluginName: string; out anInstance: IInterface)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateNonVisualPlugin (string, IHYCrossPlatformNonVisualPlugin) (declared in THYSimpleModuleManager)
Creates a new instance of the non-visual plugin with specified name. This method will automatically case new instance to a IHYCrossPlatformNonVisualPlugin.
procedure CreateNonVisualPlugin(const PluginName: string; out anInstance: IHYCrossPlatformNonVisualPlugin)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateNonVisualPlugin (string, IHYFMXNonVisualPlugin)
Creates a new instance of the non-visual plugin with specified name. This method will automatically case new instance to a IHYFMXNonVisualPlugin.
procedure CreateNonVisualPlugin(const PluginName: string; out anInstance: IHYFMXNonVisualPlugin)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateVisualPlugin
Creates a new instance of the visual plugin with specified name. This method will automatically case new instance to a IHYFMXVisualPlugin.
procedure CreateVisualPlugin(const PluginName: string; out anInstance: IHYFMXVisualPlugin; ParentControl: TControl)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
- ParentControl: Control that wil lbe used to display plugin content. Can be nil.
CreateWrapper protected override
Creates a new instance of the Delphi plugin wrapper from cross-paltform plugin instance.
function CreateWrapper(aPlugin: IDispatch; aDescriptor: THYPluginDescriptor): IInterface
Parameters:
- aPlugin: Cross-platform plugin instance
- aDescriptor: Plugin descriptor
CustomImplementer (declared in THYBaseModuleManager)
Gets or sets reference to a object that will receive QueryInterface
calls if module manager unable to process them.
property CustomImplementer: IInterface read write
EnforceSecurity (declared in THYBaseModuleManager)
Gets or sets value that indicates whether module manager will perform security checks when it creates a new instance of the plugin.
property EnforceSecurity: Boolean read write
FindModule (declared in THYBaseModuleManager)
Searches for a plugin module with given name. If module can not be found returns nil.
function FindModule(const aFileName: string): THYBaseModule
Parameters:
- aFileName: Path to the plugin module file.
FindPluginDescriptor (declared in THYSimpleModuleManager)
Searches for a plugin descriptor with given name. If descriptor can not be found returns nil.
function FindPluginDescriptor(const PluginName: string): THYCrossPlatformPluginDescriptor
Parameters:
- PluginName: Name of the plugin.
FMXModuleCreator protected override
Creates FMX module
function FMXModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
GetModuleFileNames (declared in THYBaseModuleManager)
Seaches for files with specified search pattern and fills aList
with file names.
function GetModuleFileNames(aList: TStrings; const aSearchPath: string): Integer
Parameters:
- aList: List that will be filled with file names.
- aSearchPath: Search pattern. For example
*.dll
.
HasPrivilege virtual (declared in THYBaseModuleManager)
Checks whether specified privilages is supported by this application. This method will use associated UserProfile
or (if its not available) will trigger a OnPrivilageCheck
event.
function HasPrivilege(const aPrivilege: string): Boolean
Parameters:
- aPrivilege: User defined privilage.
InstanceCount (declared in THYSimpleModuleManager)
Gets number of plugin instance that was created by module manager.
property InstanceCount: Integer read
Instances (declared in THYSimpleModuleManager)
Gets a reference to a plugin instance with specified index.
property Instances[Index: Integer]: IHYCrossPlatformPlugin read
JavaModuleCreator protected override (declared in THYSimpleModuleManager)
Creates Java module
function JavaModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
LoadComModule (declared in THYBaseModuleManager)
Loads COM module
function LoadComModule(const aGuid: string): Integer
Parameters:
- aGuid: guid
LoadFiremonkeyModule
Loads a FireMonkey plugin module with specified path.
function LoadFiremonkeyModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadJavaModule (string): THYCrossPlatformModule
Loads Java module
function LoadJavaModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadJavaModule (string): Integer (declared in THYBaseModuleManager)
Loads Java module
function LoadJavaModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadManagedModule (string, THYCLRDomain): THYCrossPlatformModule overload
Loads managed module
function LoadManagedModule(FileName: string; const aDefaultDomain: THYCLRDomain): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- aDefaultDomain: Defines default domain.
LoadManagedModule (string, Boolean): THYCrossPlatformModule overload
Loads managed module
function LoadManagedModule(FileName: string; const InNewAppDomain: Boolean): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain.
LoadManagedModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads managed module
function LoadManagedModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines default domain.
LoadManagedModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads managed module
function LoadManagedModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain.
LoadModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModule (string, THYCLRDomain): THYCrossPlatformModule overload
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const FileName: string; const aDefaultDomain: THYCLRDomain): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModule (string, Boolean): THYCrossPlatformModule overload
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const FileName: string; const InNewAppDomain: Boolean): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aDefaultDomain: THYClrDomain)
Parameters:
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (array of string, THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: array of string; const aDefaultDomain: THYClrDomain)
Parameters:
- aFileNames: Array of strings that holds file pathes.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (array of string, Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: array of string; const InNewAppDomain: Boolean)
Parameters:
- aFileNames: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (TStrings, THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: TStrings; const aDefaultDomain: THYClrDomain)
Parameters:
- aFileNames: List of strings that holds file pathes.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (TStrings, Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: TStrings; const InNewAppDomain: Boolean)
Parameters:
- aFileNames: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
function LoadModules(const aSearchPath: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aSearchPath: Search pattern. For example
*.dll
. - aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
function LoadModules(const aSearchPath: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aSearchPath: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const InNewAppDomain: Boolean)
Parameters:
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadSilverlightModule (string): THYCrossPlatformModule
Loads Silverlight module
function LoadSilverlightModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadSilverlightModule (string): Integer (declared in THYBaseModuleManager)
Loads Silverlight module
function LoadSilverlightModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadUnmanagedCrossPlatformModule (declared in THYBaseModuleManager)
Loads unmanaged crossplatform module
function LoadUnmanagedCrossPlatformModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadUnmanagedModule (string): THYCrossPlatformModule
Loads unmanaged module
function LoadUnmanagedModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadUnmanagedModule (string): Integer (declared in THYBaseModuleManager)
Loads unmanaged module
function LoadUnmanagedModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadVCLModule
Loads VCL module
function LoadVCLModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
ManagedModuleCreator protected override (declared in THYSimpleModuleManager)
Creates managed module
function ManagedModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: Defines default domain
ModuleByFileName (declared in THYBaseModuleManager)
Searches for a plugin module with given file name. If module can not be found throws EHYException.
function ModuleByFileName(const aFileName: string): THYBaseModule
Parameters:
- aFileName: File name of the plugin module.
ModuleCount (declared in THYBaseModuleManager)
Gets number of the loaded plugin modules.
property ModuleCount: Integer read
Modules (declared in THYBaseModuleManager)
Gets reference to a plugin module with specified index.
property Modules[Index: Integer]: THYBaseModule read
Modules (declared in THYSimpleModuleManager)
Gets reference to a plugin module with specified index.
property Modules[Index: Integer]: THYCrossPlatformModule read
ModulesToLoad (declared in THYBaseModuleManager)
List that holds pathes to plugin modules. This list can be used by AutoLoad
feature or by calling LoadModules
method.
property ModulesToLoad: TStrings read write
OnAfterCreateInstance
Gets or sets event handler that is fired after new plugin instance is created.
property OnAfterCreateInstance: THYAfterCreateInstanceEvent read write
delegate: procedure OnAfterCreateInstance(Sender: THYFMXModuleManager; const PluginName: string; const anInstance: IInterface)
OnAfterLoadModule
Gets or sets event handler that fired after plugin module was loaded.
property OnAfterLoadModule: THYLoadedModuleEvent read write
delegate: procedure OnAfterLoadModule(Sender: THYFMXModuleManager; Module: THYCrossPlatformModule)
OnAfterUnloadModule
Gets or sets event handler that fired after plugin module was unloaded.
property OnAfterUnloadModule: THYUnloadingModuleEvent read write
delegate: procedure OnAfterUnloadModule(Sender: THYFMXModuleManager; const FileName: string)
OnBeforeCreateInstance
Gets or sets event handler that is fired before new plugin instance is created.
property OnBeforeCreateInstance: THYBeforeCreateInstanceEvent read write
delegate: procedure OnBeforeCreateInstance(Sender: THYFMXModuleManager; const PluginName: string)
OnBeforeLoadModule
Gets or sets event handler that fired before plugin module is loaded.
property OnBeforeLoadModule: THYLoadingModuleEvent read write
delegate: procedure OnBeforeLoadModule(Sender: THYFMXModuleManager; const FileName: string; var Continue: Boolean)
OnBeforeUnloadModule
Gets or sets event handler that fired before plugin module is loaded.
property OnBeforeUnloadModule: THYLoadedModuleEvent read write
delegate: procedure OnBeforeUnloadModule(Sender: THYFMXModuleManager; Module: THYCrossPlatformModule)
OnGetAutomationObject
Gets or sets event handler that fired whenever Silverlight plugin requests for an instance of an object. Plese refer to this article for more information.
property OnGetAutomationObject: THYGetAutomationObjectEvent read write
delegate: procedure OnGetAutomationObject(Sender: THYFMXModuleManager; const ProgId: string; const Flags: THYGetAutomationObjectFlags; var Disp: IDispatch)
OnLoadModuleError
Gets or sets event handler that is triggered when error occurs while plugin module being loaded.
property OnLoadModuleError: THYLoadModuleErrorEvent read write
delegate: procedure OnLoadModuleError(Sender: THYFMXModuleManager; Error: Exception; var RaiseException: Boolean)
OnNotifySilverlightError
Gets or sets event handler that is triggered whenever error occurs in Silverlight plugin.
property OnNotifySilverlightError: THYNotifySilverlightErrorEvent read write
delegate: procedure OnNotifySilverlightError(Sender: THYFMXModuleManager; const Error: string; const Source: string; const Line: Integer; const Column: Integer)
OnPrivilegeCheck (declared in THYBaseModuleManager)
Gets or sets event handler that fired whenever privilage check is performed.
property OnPrivilegeCheck: THYCustomPrivilegeCheckEvent read write
delegate: procedure OnPrivilegeCheck(Sender: TObject; const aPrivilege: string; var HasPrivilege: Boolean)
PluginDescriptorByName (declared in THYSimpleModuleManager)
Searches for a plugin descriptor with given name. If descriptor can not be found throws EHYException.
function PluginDescriptorByName(const PluginName: string): THYCrossPlatformPluginDescriptor
Parameters:
- PluginName: Name of the plugin.
PluginDescriptorCount (declared in THYSimpleModuleManager)
Gets number of the loaded plugin descriptors.
property PluginDescriptorCount: Integer read
PluginDescriptors (declared in THYSimpleModuleManager)
The reference to a plugin descriptor with specified index.
property PluginDescriptors[Index: Integer]: THYCrossPlatformPluginDescriptor read
QueryInterface protected reintroduce stdcall (declared in THYBaseModuleManager)
function QueryInterface(const IID: TGUID; out Obj: ): HResult
Parameters:
- IID:
- Obj:
RegisterPlugins protected virtual (declared in THYSimpleModuleManager)
Registers plugins from the module.
procedure RegisterPlugins(aModule: THYCrossPlatformModule)
Parameters:
- aModule: module
ReleaseInstance (declared in THYSimpleModuleManager)
Releases a specififed instance of the plugin.
procedure ReleaseInstance(var anInstance: )
Parameters:
- anInstance: Reference to a plugin instance.
ResolveInterfacesToOwner (declared in THYBaseModuleManager)
Gets or sets value which is used to indicate whether module manager will try to resolve interfaces from its owner or from CustomImplementer
.
property ResolveInterfacesToOwner: Boolean read write
SilverlightModuleCreator protected override
Creates Silverlight module
function SilverlightModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
TryLoadModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically. If succeeds returns index of the module otherwise -1.
function TryLoadModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
TryLoadModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically. If succeeds returns index of the module otherwise -1.
function TryLoadModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
UnloadModule (THYBaseModule) override (declared in THYSimpleModuleManager)
Unloads specific plugin module
procedure UnloadModule(aModule: THYBaseModule)
Parameters:
- aModule: The plugin module
UnloadModule (Integer) overload (declared in THYBaseModuleManager)
Unloads plugin module with specified index.
procedure UnloadModule(Index: Integer)
Parameters:
- Index: Index of the plugin module.
UnloadModule (string) overload (declared in THYBaseModuleManager)
Unloads plugin module with specified file name.
procedure UnloadModule(const aFileName: string)
Parameters:
- aFileName: Index of the plugin module.
UnloadModules (declared in THYBaseModuleManager)
Unloads all plugin modules.
procedure UnloadModules
UnmanagedCrossPlatformModuleCreator protected override (declared in THYSimpleModuleManager)
Creates unmanaged cross platform module
function UnmanagedCrossPlatformModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
UnregisterPlugins protected virtual (declared in THYSimpleModuleManager)
Unregisters plugins from the module.
procedure UnregisterPlugins(Module: THYCrossPlatformModule)
Parameters:
- Module: module
VCLModuleCreator protected virtual (declared in THYBaseModuleManager)
Creates VCL module
function VCLModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
AutoLoad (declared in THYBaseModuleManager)
Gets or sets value that indicates whether module manager will automaticaly load plugin modules from ModulesToLoad
list.
property AutoLoad: Boolean read write
AutoLoading (declared in THYBaseModuleManager)
Gets value that indicates whether module manager performing auto-load operation at the moment.
property AutoLoading: Boolean read
CustomImplementer (declared in THYBaseModuleManager)
Gets or sets reference to a object that will receive QueryInterface
calls if module manager unable to process them.
property CustomImplementer: IInterface read write
EnforceSecurity (declared in THYBaseModuleManager)
Gets or sets value that indicates whether module manager will perform security checks when it creates a new instance of the plugin.
property EnforceSecurity: Boolean read write
InstanceCount (declared in THYSimpleModuleManager)
Gets number of plugin instance that was created by module manager.
property InstanceCount: Integer read
Instances (declared in THYSimpleModuleManager)
Gets a reference to a plugin instance with specified index.
property Instances[Index: Integer]: IHYCrossPlatformPlugin read
ModuleCount (declared in THYBaseModuleManager)
Gets number of the loaded plugin modules.
property ModuleCount: Integer read
Modules (declared in THYBaseModuleManager)
Gets reference to a plugin module with specified index.
property Modules[Index: Integer]: THYBaseModule read
Modules (declared in THYSimpleModuleManager)
Gets reference to a plugin module with specified index.
property Modules[Index: Integer]: THYCrossPlatformModule read
ModulesToLoad (declared in THYBaseModuleManager)
List that holds pathes to plugin modules. This list can be used by AutoLoad
feature or by calling LoadModules
method.
property ModulesToLoad: TStrings read write
PluginDescriptorCount (declared in THYSimpleModuleManager)
Gets number of the loaded plugin descriptors.
property PluginDescriptorCount: Integer read
PluginDescriptors (declared in THYSimpleModuleManager)
The reference to a plugin descriptor with specified index.
property PluginDescriptors[Index: Integer]: THYCrossPlatformPluginDescriptor read
ResolveInterfacesToOwner (declared in THYBaseModuleManager)
Gets or sets value which is used to indicate whether module manager will try to resolve interfaces from its owner or from CustomImplementer
.
property ResolveInterfacesToOwner: Boolean read write
ComModuleCreator protected override (declared in THYSimpleModuleManager)
Creates COM module
function ComModuleCreator(const aGuid: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aGuid: guid
- aDefaultDomain: ignored
CreateInstance (string): IInterface overload (declared in THYBaseModuleManager)
Creates a new instance of the plugin with specified name.
function CreateInstance(const PluginName: string): IInterface
Parameters:
- PluginName: Name of the plugin instance.
CreateInstance (string, IInterface) override (declared in THYSimpleModuleManager)
Creates a new instance of the plugin with specified name.
procedure CreateInstance(const PluginName: string; out anInstance: IInterface)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateNonVisualPlugin (string, IHYCrossPlatformNonVisualPlugin) (declared in THYSimpleModuleManager)
Creates a new instance of the non-visual plugin with specified name. This method will automatically case new instance to a IHYCrossPlatformNonVisualPlugin.
procedure CreateNonVisualPlugin(const PluginName: string; out anInstance: IHYCrossPlatformNonVisualPlugin)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateNonVisualPlugin (string, IHYFMXNonVisualPlugin)
Creates a new instance of the non-visual plugin with specified name. This method will automatically case new instance to a IHYFMXNonVisualPlugin.
procedure CreateNonVisualPlugin(const PluginName: string; out anInstance: IHYFMXNonVisualPlugin)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
CreateVisualPlugin
Creates a new instance of the visual plugin with specified name. This method will automatically case new instance to a IHYFMXVisualPlugin.
procedure CreateVisualPlugin(const PluginName: string; out anInstance: IHYFMXVisualPlugin; ParentControl: TControl)
Parameters:
- PluginName: Name of the plugin instance.
- anInstance: Pointer to the new instance of the plugin.
- ParentControl: Control that wil lbe used to display plugin content. Can be nil.
CreateWrapper protected override
Creates a new instance of the Delphi plugin wrapper from cross-paltform plugin instance.
function CreateWrapper(aPlugin: IDispatch; aDescriptor: THYPluginDescriptor): IInterface
Parameters:
- aPlugin: Cross-platform plugin instance
- aDescriptor: Plugin descriptor
FindModule (declared in THYBaseModuleManager)
Searches for a plugin module with given name. If module can not be found returns nil.
function FindModule(const aFileName: string): THYBaseModule
Parameters:
- aFileName: Path to the plugin module file.
FindPluginDescriptor (declared in THYSimpleModuleManager)
Searches for a plugin descriptor with given name. If descriptor can not be found returns nil.
function FindPluginDescriptor(const PluginName: string): THYCrossPlatformPluginDescriptor
Parameters:
- PluginName: Name of the plugin.
FMXModuleCreator protected override
Creates FMX module
function FMXModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
GetModuleFileNames (declared in THYBaseModuleManager)
Seaches for files with specified search pattern and fills aList
with file names.
function GetModuleFileNames(aList: TStrings; const aSearchPath: string): Integer
Parameters:
- aList: List that will be filled with file names.
- aSearchPath: Search pattern. For example
*.dll
.
HasPrivilege virtual (declared in THYBaseModuleManager)
Checks whether specified privilages is supported by this application. This method will use associated UserProfile
or (if its not available) will trigger a OnPrivilageCheck
event.
function HasPrivilege(const aPrivilege: string): Boolean
Parameters:
- aPrivilege: User defined privilage.
JavaModuleCreator protected override (declared in THYSimpleModuleManager)
Creates Java module
function JavaModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
LoadComModule (declared in THYBaseModuleManager)
Loads COM module
function LoadComModule(const aGuid: string): Integer
Parameters:
- aGuid: guid
LoadFiremonkeyModule
Loads a FireMonkey plugin module with specified path.
function LoadFiremonkeyModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadJavaModule (string): THYCrossPlatformModule
Loads Java module
function LoadJavaModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadJavaModule (string): Integer (declared in THYBaseModuleManager)
Loads Java module
function LoadJavaModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadManagedModule (string, THYCLRDomain): THYCrossPlatformModule overload
Loads managed module
function LoadManagedModule(FileName: string; const aDefaultDomain: THYCLRDomain): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- aDefaultDomain: Defines default domain.
LoadManagedModule (string, Boolean): THYCrossPlatformModule overload
Loads managed module
function LoadManagedModule(FileName: string; const InNewAppDomain: Boolean): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain.
LoadManagedModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads managed module
function LoadManagedModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines default domain.
LoadManagedModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads managed module
function LoadManagedModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain.
LoadModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModule (string, THYCLRDomain): THYCrossPlatformModule overload
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const FileName: string; const aDefaultDomain: THYCLRDomain): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModule (string, Boolean): THYCrossPlatformModule overload
Loads a plugin module with specified path, type of the plugin will be detected automatically.
function LoadModule(const FileName: string; const InNewAppDomain: Boolean): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aDefaultDomain: THYClrDomain)
Parameters:
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (array of string, THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: array of string; const aDefaultDomain: THYClrDomain)
Parameters:
- aFileNames: Array of strings that holds file pathes.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (array of string, Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: array of string; const InNewAppDomain: Boolean)
Parameters:
- aFileNames: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (TStrings, THYClrDomain) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: TStrings; const aDefaultDomain: THYClrDomain)
Parameters:
- aFileNames: List of strings that holds file pathes.
- aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (TStrings, Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
procedure LoadModules(const aFileNames: TStrings; const InNewAppDomain: Boolean)
Parameters:
- aFileNames: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
function LoadModules(const aSearchPath: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aSearchPath: Search pattern. For example
*.dll
. - aDefaultDomain: Defines default domain. Affects only managed plugin modules.
LoadModules (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads all plugin modules that fits into specified search pattern, type of the plugins will be detected automatically.
function LoadModules(const aSearchPath: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aSearchPath: Search pattern. For example
*.dll
. - InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadModules (Boolean) overload (declared in THYBaseModuleManager)
Loads all plugin modules from the ModulesToLoad
list, type of the plugins will be detected automatically.
procedure LoadModules(const InNewAppDomain: Boolean)
Parameters:
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
LoadSilverlightModule (string): THYCrossPlatformModule
Loads Silverlight module
function LoadSilverlightModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadSilverlightModule (string): Integer (declared in THYBaseModuleManager)
Loads Silverlight module
function LoadSilverlightModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadUnmanagedCrossPlatformModule (declared in THYBaseModuleManager)
Loads unmanaged crossplatform module
function LoadUnmanagedCrossPlatformModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadUnmanagedModule (string): THYCrossPlatformModule
Loads unmanaged module
function LoadUnmanagedModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
LoadUnmanagedModule (string): Integer (declared in THYBaseModuleManager)
Loads unmanaged module
function LoadUnmanagedModule(const aFileName: string): Integer
Parameters:
- aFileName: Path to the plugin module.
LoadVCLModule
Loads VCL module
function LoadVCLModule(FileName: string): THYCrossPlatformModule
Parameters:
- FileName: Path to the plugin module.
ManagedModuleCreator protected override (declared in THYSimpleModuleManager)
Creates managed module
function ManagedModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: Defines default domain
ModuleByFileName (declared in THYBaseModuleManager)
Searches for a plugin module with given file name. If module can not be found throws EHYException.
function ModuleByFileName(const aFileName: string): THYBaseModule
Parameters:
- aFileName: File name of the plugin module.
PluginDescriptorByName (declared in THYSimpleModuleManager)
Searches for a plugin descriptor with given name. If descriptor can not be found throws EHYException.
function PluginDescriptorByName(const PluginName: string): THYCrossPlatformPluginDescriptor
Parameters:
- PluginName: Name of the plugin.
QueryInterface protected reintroduce stdcall (declared in THYBaseModuleManager)
function QueryInterface(const IID: TGUID; out Obj: ): HResult
Parameters:
- IID:
- Obj:
RegisterPlugins protected virtual (declared in THYSimpleModuleManager)
Registers plugins from the module.
procedure RegisterPlugins(aModule: THYCrossPlatformModule)
Parameters:
- aModule: module
ReleaseInstance (declared in THYSimpleModuleManager)
Releases a specififed instance of the plugin.
procedure ReleaseInstance(var anInstance: )
Parameters:
- anInstance: Reference to a plugin instance.
SilverlightModuleCreator protected override
Creates Silverlight module
function SilverlightModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
TryLoadModule (string, THYClrDomain): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically. If succeeds returns index of the module otherwise -1.
function TryLoadModule(const aFileName: string; const aDefaultDomain: THYClrDomain): Integer
Parameters:
- aFileName: Path to the plugin module.
- aDefaultDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
TryLoadModule (string, Boolean): Integer overload (declared in THYBaseModuleManager)
Loads a plugin module with specified path, type of the plugin will be detected automatically. If succeeds returns index of the module otherwise -1.
function TryLoadModule(const aFileName: string; const InNewAppDomain: Boolean): Integer
Parameters:
- aFileName: Path to the plugin module.
- InNewAppDomain: Defines whether plugin module will be loaded in a separate AppDomain. Affects only managed plugin modules.
UnloadModule (THYBaseModule) override (declared in THYSimpleModuleManager)
Unloads specific plugin module
procedure UnloadModule(aModule: THYBaseModule)
Parameters:
- aModule: The plugin module
UnloadModule (Integer) overload (declared in THYBaseModuleManager)
Unloads plugin module with specified index.
procedure UnloadModule(Index: Integer)
Parameters:
- Index: Index of the plugin module.
UnloadModule (string) overload (declared in THYBaseModuleManager)
Unloads plugin module with specified file name.
procedure UnloadModule(const aFileName: string)
Parameters:
- aFileName: Index of the plugin module.
UnloadModules (declared in THYBaseModuleManager)
Unloads all plugin modules.
procedure UnloadModules
UnmanagedCrossPlatformModuleCreator protected override (declared in THYSimpleModuleManager)
Creates unmanaged cross platform module
function UnmanagedCrossPlatformModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
UnregisterPlugins protected virtual (declared in THYSimpleModuleManager)
Unregisters plugins from the module.
procedure UnregisterPlugins(Module: THYCrossPlatformModule)
Parameters:
- Module: module
VCLModuleCreator protected virtual (declared in THYBaseModuleManager)
Creates VCL module
function VCLModuleCreator(const aFileName: string; const aDefaultDomain: THYClrDomain): THYBaseModule
Parameters:
- aFileName: filename
- aDefaultDomain: ignored
OnAfterCreateInstance
Gets or sets event handler that is fired after new plugin instance is created.
property OnAfterCreateInstance: THYAfterCreateInstanceEvent read write
delegate: procedure OnAfterCreateInstance(Sender: THYFMXModuleManager; const PluginName: string; const anInstance: IInterface)
OnAfterLoadModule
Gets or sets event handler that fired after plugin module was loaded.
property OnAfterLoadModule: THYLoadedModuleEvent read write
delegate: procedure OnAfterLoadModule(Sender: THYFMXModuleManager; Module: THYCrossPlatformModule)
OnAfterUnloadModule
Gets or sets event handler that fired after plugin module was unloaded.
property OnAfterUnloadModule: THYUnloadingModuleEvent read write
delegate: procedure OnAfterUnloadModule(Sender: THYFMXModuleManager; const FileName: string)
OnBeforeCreateInstance
Gets or sets event handler that is fired before new plugin instance is created.
property OnBeforeCreateInstance: THYBeforeCreateInstanceEvent read write
delegate: procedure OnBeforeCreateInstance(Sender: THYFMXModuleManager; const PluginName: string)
OnBeforeLoadModule
Gets or sets event handler that fired before plugin module is loaded.
property OnBeforeLoadModule: THYLoadingModuleEvent read write
delegate: procedure OnBeforeLoadModule(Sender: THYFMXModuleManager; const FileName: string; var Continue: Boolean)
OnBeforeUnloadModule
Gets or sets event handler that fired before plugin module is loaded.
property OnBeforeUnloadModule: THYLoadedModuleEvent read write
delegate: procedure OnBeforeUnloadModule(Sender: THYFMXModuleManager; Module: THYCrossPlatformModule)
OnGetAutomationObject
Gets or sets event handler that fired whenever Silverlight plugin requests for an instance of an object. Plese refer to this article for more information.
property OnGetAutomationObject: THYGetAutomationObjectEvent read write
delegate: procedure OnGetAutomationObject(Sender: THYFMXModuleManager; const ProgId: string; const Flags: THYGetAutomationObjectFlags; var Disp: IDispatch)
OnLoadModuleError
Gets or sets event handler that is triggered when error occurs while plugin module being loaded.
property OnLoadModuleError: THYLoadModuleErrorEvent read write
delegate: procedure OnLoadModuleError(Sender: THYFMXModuleManager; Error: Exception; var RaiseException: Boolean)
OnNotifySilverlightError
Gets or sets event handler that is triggered whenever error occurs in Silverlight plugin.
property OnNotifySilverlightError: THYNotifySilverlightErrorEvent read write
delegate: procedure OnNotifySilverlightError(Sender: THYFMXModuleManager; const Error: string; const Source: string; const Line: Integer; const Column: Integer)
OnPrivilegeCheck (declared in THYBaseModuleManager)
Gets or sets event handler that fired whenever privilage check is performed.
property OnPrivilegeCheck: THYCustomPrivilegeCheckEvent read write
delegate: procedure OnPrivilegeCheck(Sender: TObject; const aPrivilege: string; var HasPrivilege: Boolean)