[This is preliminary documentation and is subject to change.]
An interface for simple plugins for use in extending Mini SQL Query.
Plugins are loaded from DLL's in the working directory matching the pattern "MiniSqlQuery.*.PlugIn.dll"
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IPlugIn
Public Interface IPlugIn
public interface class IPlugIn
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | InitializePlugIn()()() |
Initializes the plug in, called after the main form is displayed.
|
| LoadPlugIn(ApplicationServices) |
Loads the plugin and stores a reference to the service container.
Called at application startup time.
|
 | PluginDescription |
A brief description of the plugin.
|
| PluginName |
The descriptive name of the plugin.
|
| RequestedLoadOrder |
Plugin load order. For external plugins start with values over 1000.
This is a simple way of handling dependencies of other services etc.
|
| UnloadPlugIn()()() |
Called when the plugin is unloading (typically application shutdown).
|
Remarks
Plugins are created during the load process.
After all plugins are loaded they are sorted by the RequestedLoadOrder property.
Next the LoadPlugIn(ApplicationServices) method is called on each in turn supplying a reference to
ApplicationServices.
This is where commands should be created and assigned to buttons, menus etc.
These services provide access to the rest of the editor.
Next the main application form is displayed and after all control creation is complete (i.e. the Form
Shown event) is complete a call to InitializePlugIn()()() is made for each loaded plugin.