PluginAPIVBNet
SwordfishUser.PluginAPIVBNet History
Hide minor edits - Show changes to output
Changed lines 5-6 from:
to:
[[Profiles.StevenWright | Steven Wright]]
Changed lines 3-4 from:
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE. The class has been developed with Microsoft
to:
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE. The class has been developed with Microsoft Visual Basic 2008 Express Edition.
Changed lines 47-48 from:
Download an example showing the use of all of the class properties, methods and events.
to:
Download an example showing the use of all of the class properties, methods and events (written in Microsoft Visual Basic 2008 Express Edition).
Changed lines 3-4 from:
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE.
to:
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE. The class has been developed with Microsoft
Added lines 50-51:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/TestPlugin.png
Changed lines 41-49 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddEvent.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddEvent.png
!!!Example
Download an example showing the use of all of the class properties, methods and events.
%lfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/download.gif
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPluginExample.zip | Download Example Project »]]
!!!Example
Download an example showing the use of all of the class properties, methods and events.
%lfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/download.gif
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPluginExample.zip | Download Example Project »]]
Changed lines 37-41 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
7. To respond to Swordfish IDE messages, declare your own subroutines to handle an event, e.g. 'Private Sub PreCompile() Handles SF.PreCompile'.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddEvent.png
7. To respond to Swordfish IDE messages, declare your own subroutines to handle an event, e.g. 'Private Sub PreCompile() Handles SF.PreCompile'.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddEvent.png
Changed lines 23-24 from:
3. In your form code, add a reference to the pluin class, using 'Dim WithEvents SF As New SwordfishIDEPlugin' - use the WithEvents switch to allow access to the Swordfish IDE events.
to:
3. In your form code, add a reference to the plugin class, using 'Dim WithEvents SF As New SwordfishIDEPlugin' - use the WithEvents switch to allow access to the Swordfish IDE events.
Changed lines 23-24 from:
3. In your form code, add a reference to the pluing class, using 'Dim WithEvents SF As New SwordfishIDEPlugin' - use the WithEvents switch to allow access to the Swordfish IDE events.
to:
3. In your form code, add a reference to the pluin class, using 'Dim WithEvents SF As New SwordfishIDEPlugin' - use the WithEvents switch to allow access to the Swordfish IDE events.
Changed lines 17-18 from:
%rightt% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Deleted lines 14-15:
Changed lines 16-18 from:
to:
%rightt% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Added lines 21-22:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
Changed line 18 from:
to:
----
Deleted lines 22-23:
Changed lines 25-26 from:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
Changed lines 29-30 from:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
Changed lines 33-35 from:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
Changed line 18 from:
to:
Added lines 23-24:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
Changed lines 27-28 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
Changed lines 31-32 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
Changed lines 35-39 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
Changed line 18 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
Added line 15:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Changed lines 18-19 from:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
Deleted lines 20-21:
Changed lines 17-18 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Changed lines 31-37 from:
to:
5. You must also add code to disconnect from the IDE when your plugin closes.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
6. Note that the plugin will not connect to the IDE if run from within the Microsoft Visual Studio development environment. Instead, the exe must be run from within the Swordfish IDE as a plugin. You will need to add your application to the IDE using the Plugin Editor in Swordfish.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishPluginMenu.png
Changed lines 23-25 from:
3. In your form code, add a reference to the pluing class - use the WithEvents switch to allow access to the Swordfish IDE events.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
%right% http://www
to:
3. In your form code, add a reference to the pluing class, using 'Dim WithEvents SF As New SwordfishIDEPlugin' - use the WithEvents switch to allow access to the Swordfish IDE events.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
4. To allow access to the IDE through the API, you need first to connect to the IDE. This could be done in the form load event. You need to pass the window handle to the Connect function, using 'SF.Connect(Me.Handle)'. Note that the class provides context help with use and parameters for each property, method and event.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
4. To allow access to the IDE through the API, you need first to connect to the IDE. This could be done in the form load event. You need to pass the window handle to the Connect function, using 'SF.Connect(Me.Handle)'. Note that the class provides context help with use and parameters for each property, method and event.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/Connect.png
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/ConnectAndDisconnect.png
Changed lines 21-25 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
3. In your form code, add a reference to the pluing class - use the WithEvents switch to allow access to the Swordfish IDE events.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
3. In your form code, add a reference to the pluing class - use the WithEvents switch to allow access to the Swordfish IDE events.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/DimWithEvents.png
Changed lines 17-21 from:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
2. You should now have a copy of SwordfishIDEPlugin.vb in your project.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
2. You should now have a copy of SwordfishIDEPlugin.vb in your project.
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SolutionExplorer.png
Changed line 17 from:
%r% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%right% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Changed line 17 from:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%r% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Changed line 17 from:
http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
to:
%rfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Added line 17:
http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/AddExistingItem.png
Changed lines 5-6 from:
to:
!!!Download
Changed lines 13-16 from:
to:
!!!Instructions
1. Add the class to your project by right-clicking on the project in the Solution Explorer and adding an existing item...
1. Add the class to your project by right-clicking on the project in the Solution Explorer and adding an existing item...
Changed lines 11-16 from:
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module (right-click and 'Save Target As' »]]
to:
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module (right-click and 'Save Target As') »]]
Changed lines 11-16 from:
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module »]]
to:
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module (right-click and 'Save Target As' »]]
Changed lines 5-8 from:
to:
!!Download
Download the class module below and then insert into your Visual Basic project (instructions below).
%lfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/download.gif
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module »]]
Download the class module below and then insert into your Visual Basic project (instructions below).
%lfloat% http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/download.gif
[[http://www.sfcompiler.co.uk/wiki/uploads/StevenWright/SwordfishIDEPlugin/SwordfishIDEPlugin.vb | Download Class Module »]]
Added lines 1-8:
!!!Introduction
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE.
This is a Visual Basic .Net class that allows easy interfacing to the Swordfish Plugin API. It provides properties and methods, as well as events to handle messages from the Swordfish IDE.