Click or drag to resize

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.1.0.1 (2.1.0.1)
Syntax
C#
public interface IModule : IMethodSource

The IModule type exposes the following members.

Properties
  NameDescription
Public propertyAssemblyName
Name of the assembly from where the module is loaded.
Public propertyConfiguration
Access to module's configuration object.
Public propertyConfigurationRequired
Specifies whether the module requires configuration or not.
Public propertyModuleManager
Access to the module manager that initializes the instance.
Top
Methods
  NameDescription
Public methodGetConfigKey
Resolves the default configuration key for configurations of this module.
Public methodGetMethodsByAttributeT
Returns a collection of methods decorated with the given attribute.
(Inherited from IMethodSource.)
Public methodGetModuleDescription
Returns the module description.
Public methodGetModuleName
Returns the module name for UI.
Public methodInitialize
Used for module initialization that may include dependencies on other modules. It is automatically called by the Configuration Manager after all modules are loaded.
Public methodLoadConfiguration
LoadConfiguration loads the configuration of the owner module from the vault.
Public methodStart
Used for indicating the module start. It is automatically called by the Configuration Manager after all modules are initialized.
Public methodStop
Used for indicating the module stop. It is automatically called by the Configuration Manager for all modules before are initialized.
Public methodUninitialize
Used for indicating the module un-initialization.
Public methodUnloadConfiguration
Removes the configuration.
Public methodValidateConfiguration
Method to Validate the modules configuration in this vault. Updates the configurations IsValid.
Public methodValidateConfigurationSyntax
Validates the configuration data syntax without touching running configuration.
Top
See Also