What You Need

Here is what you need before you begin:

• Latest build of MadCap Flare
• B3.PluginAPIKit.dll
• Visual Studio 2010 or later

How to Create a Plug-In

1. In Visual Studio, create a new Class Library project.
2. In the new project dialog, select .Net Framework 4.0.
3. Add a library reference to the B3.PluginAPIKit.dll assembly.

4. Implement the IPlugin interface. See IPlugin Interface.

   Following is a basic example where the function of the plug-in is to simply show a message box whenever the plug-in is activated or deactivated.

   Copy

   using System;
   using System.Windows.Forms;
   using B3.PluginAPIKit;
   namespace DemoPlugin
   {
       public class DemoPlugin:IPlugin
       {
           private IHost mHost;
           private bool mActivated;
           public bool IsActivated
           {
               get { return mActivated; }
           }
           public string GetVersion()
           {
               return "1.0";
           }
           public string GetAuthor()
           {
                return "Bob Smith";
             }
             public string GetDescription()
             {
                return "Displays a message box.";
             }
             public string GetName()
             {
                Return "DemoPlugin";
             }
             public void Initialize(IHost host)
             {
                mHost = host;
             }
             public void Execute()
             {
                mActivated = true;
                MessageBox.Show(GetName() + " activated!");
             }
             public void Stop()
             {
                MessageBox.Show(GetName() + " deactivated!");
                mHost.Dispose();
                mActivated = false;
             }
          }
   }

How to Integrate a Plug-In Into Flare

Flare monitors the Plugins folder under its root application directory. Any valid plug-in detected inside the Plugins folder will be listed on the Plugins tab of the Options dialog in Flare.

1. Make sure Flare is not open.

2. In Windows navigate to the Flare.app\Plugins folder where you have installed Flare (e.g., C:\Program Files\MadCap Software\MadCap Flare20\Flare.app\Plugins).

   

3. Within the Plugins directory, create a new folder named after your plugin. For the example above, the plugin directory is named “DemoPlugin.”

4. Add your built plug-in assemblies and resource files into that directory. The directory hierarchy should look as follows:

   

How to Enable the Plug-In Within Flare

1. Launch Flare.
2. Select File > Options. The Options dialog opens.
3. Select the Plugins tab. You should see a row that represents your DLL.

4. Click Enable.

   

   Note You can also use the Plugins tab in the Options dialog (File > Options) to disable a plugin.

5. Restart Flare.

Interfaces and Enumerations

For more details on the interfaces and enumerations with the plug-in API, see the following:

• IPlugin Interface
• IHost Interface
  • IEditorContext Interface
    • IDocument Interface
    • ISelection Interface
    • EditorView Enumeration
  • INavContext Interface
    • ICustomToolBar Interface
    • IToolStripMenuItem Interface
    • IRibbon Interface
    • IRibbonControlData Interface
    • IRibbonMenuData Interface
    • IRibbonTab Interface
    • IRibbonGroup Interface
    • IRibbonComboBox Interface
    • IRibbonMenu Interface
    • RibbonIconSize Enumeration

Examples

For examples of creating and working with the plug-in API, see the following:

• Context Menu Example
• Controlled Language Example
• Ribbon Example
• Search and Change Text Style Example
• Toolbar Example

Best Practices/Guidelines

Following are some best practices an guidelines to keep in mind as you work with the plug-in API.