CommandFusion Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Plugins ======

The plugin interface in guiDesigner allows .NET developers to create plugins which interact with projects in guiDesigner.\\
This opens the doors for better integration with your favourite automation hardware, and custom workflow.

==== Requirements ====


===== Plugin Installation =====
Note: Before installing any plugins, please make sure all instances of guiDesigner are closed!\\

There are two methods to install plugin into guiDesigner:\\
  - <del>Automatically install from web browser</del>
  - Download and unzip into the plugins folder

==== Automatic Installation ====
<WRAP center round alert 90%>
**NOT YET IMPLEMENTED**\\
If you have guiDesigner installed on your PC, you can quickly install any plugin by changing the download path of the plugin to start with cf:// instead of http://\\
You must have guiDesigner installed on your PC for this to work, otherwise you can download the plugin from any PC and install it later using the manual method below.
</WRAP>



==== Manual Installation ====
After downloading a plugin, you must simply need to unzip it to the 'plugins' folder of your guiDesigner installation.\\
By default, this is ''c:\Program Files\CommandFusion\plugins''

===== Development =====
Anyone can create a plugin for guiDesigner by implementing our Plugin Interface, CFPlugin.dll\\
Here is a short guide on creating a plugin in VB.NET:
  - Create a new project in Visual Studio (preferably using .NET 2.0 as that is what guiDesigner requires)
  - Select 'Class Library' project type and press OK
  - Delete the default class file that is automatically created, and instead add a new form to the project.
  - This form now has to implement our CFPlugin interface.
  - Add a reference to the CFPlugin.dll (grab it from our [[http://commandfusion.googlecode.com/svn/trunk/guiDesigner_plugins/plugin%20interface/|Google Code Repository]])
  - Implement the dll in the newly added form (add "Implements CommandFusion.CFPlugin" after the class definition) and press enter
  - The code required for the plugin implementation should be automatically generated for you. See the demo video below for further details.

==== Demo Plugin ====
You can grab a copy of a Demo Plugin from our [[http://commandfusion.googlecode.com/svn/trunk/guiDesigner_plugins/plugin%20interface/|Google Code Repository]].\\
NOTE: If you have problems building the solution, check the 'Build Events' in the project properties under the 'Compile' tab. Make sure it points to the plugin location where guiDesigner is installed on your machine.

==== Video Demonstration of Developing Demo Plugin ====
Here is a video demonstrating how to create a guiDesigner plugin in VB.NET. It covers the basics you need to know to get started.\\
<WRAP center round important 90%>
NOTE: Demo video is a little outdated, but basic principles still apply.\\
See the Demo Plugin download on our [[http://commandfusion.googlecode.com/svn/trunk/guiDesigner_plugins/plugin%20interface/|Google Code Repository]] for the latest example.
</WRAP>

{{url>http://player.vimeo.com/video/8239148 500px,319px noscroll noborder alignment|guiDesigner Plugin Development Demo}}

You can also download the original Quicktime video from the videos Vimeo page:\\
http://vimeo.com/8239148
CommandFusion Wiki

User Tools

Site Tools

Page Tools
