IModule Interface |
Common interface for all modules.
Use abstract GenericModule class to get suitable implementation to all but LoadConfiguration().
Namespace: MFiles.VAF.Module
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 2.3.623.2
SyntaxThe IModule type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AssemblyName |
Name of the assembly from where the module is loaded.
|
| Configuration |
Access to module's configuration object.
|
| ConfigurationRequired |
Specifies whether the module requires configuration or not.
|
| ModuleManager |
Access to the module manager that initializes the instance.
|
Methods| Name | Description | |
|---|---|---|
 | GetConfigKey |
Resolves the default configuration key for configurations of this module.
|
| GetMethodsByAttributeT |
Returns a collection of methods decorated with the given attribute.
(Inherited from IMethodSource.) |
| GetModuleDescription |
Returns the module description.
|
| GetModuleName |
Returns the module name for UI.
|
| Initialize |
Used for module initialization that may include dependencies on other modules.
It is automatically called by the Configuration Manager after all modules are loaded.
|
| LoadConfiguration |
LoadConfiguration loads the configuration of the owner module from the vault.
|
| Start |
Used for indicating the module start. It is automatically called by the Configuration
Manager after all modules are initialized.
|
| Stop |
Used for indicating the module stop. It is automatically called by the Configuration
Manager for all modules before are initialized.
|
| Uninitialize |
Used for indicating the module un-initialization.
|
| UnloadConfiguration |
Removes the configuration.
|
| ValidateConfiguration |
Method to Validate the modules configuration in this vault.
Updates the configurations IsValid.
|
| ValidateConfigurationSyntax |
Validates the configuration data syntax without touching running configuration.
|
See Also