IPlugin Interface

Information for Developers

The IPlugin interface represents the plug-in. For the plug-in assembly to be considered valid, it must implement the IPlugin interface.

[Menu Proxy — Headings — Online — Depth3 ]

Properties

  • bool IsActivated Gets a value indicating whether the plug-in is activated or not.

Methods

  • void Execute() Activates the plug-in. This method is called when users click Enable on the Plugins tab of the Options dialog (File > Options).
  • string GetAuthor() Returns the author of the plug-in.
  • string GetDescription() Returns the description of the plug-in.
  • string GetName() Returns the name of the plug-in.
  • string GetVersion() Returns the version of the plug-in.
  • void Initialize(IHost) Initializes the plug-in. An instance of IHost is passed in as a parameter, which gives users access to Flare components. See IHost Interface.
  • void Stop() Deactivates the plug-in. This method is called when users click Disable on the Plugins tab of the Options dialog (File > Options).