diff --git a/samples/LineCounter/Article/LineCounterSDAddIn/LineCounter.sdaddin b/samples/LineCounter/Article/LineCounterSDAddIn/LineCounter.sdaddin
new file mode 100644
index 0000000000..3eabb6da92
Binary files /dev/null and b/samples/LineCounter/Article/LineCounterSDAddIn/LineCounter.sdaddin differ
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/addinmanager.png b/samples/LineCounter/Article/LineCounterSDAddIn/addinmanager.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/addinmanager.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/addinmanager.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/projectbrowser.png b/samples/LineCounter/Article/LineCounterSDAddIn/projectbrowser.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/projectbrowser.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/projectbrowser.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/properties.png b/samples/LineCounter/Article/LineCounterSDAddIn/properties.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/properties.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/properties.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/screenshot.png b/samples/LineCounter/Article/LineCounterSDAddIn/screenshot.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/screenshot.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/screenshot.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/screenshot2.png b/samples/LineCounter/Article/LineCounterSDAddIn/screenshot2.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/screenshot2.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/screenshot2.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn/templatetype.png b/samples/LineCounter/Article/LineCounterSDAddIn/templatetype.png
similarity index 100%
rename from samples/LineCounter/Article/LineCounterSharpDevelopAddIn/templatetype.png
rename to samples/LineCounter/Article/LineCounterSDAddIn/templatetype.png
diff --git a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn.html b/samples/LineCounter/Article/LineCounterSharpDevelopAddIn.html
index e01d449a0c..ab9d87648c 100644
--- a/samples/LineCounter/Article/LineCounterSharpDevelopAddIn.html
+++ b/samples/LineCounter/Article/LineCounterSharpDevelopAddIn.html
@@ -13,21 +13,25 @@
-
When seeing the article
Line
Counter - Writing a Visual Studio 2005 Add-In
-[^],
+[^]
+written by Jon Rista,
I wanted to show you how to write that AddIn for SharpDevelop.
In this article I will show you how to create an AddIn, but I will not discuss
the concepts of the SharpDevelop's AddIn architecture here - you can read more
@@ -36,23 +40,24 @@ about that in my article
Applications with the SharpDevelop Core
[^].
The line counter code is taken from the VS 2005 AddIn written by Jon Rista; the
-counting algorithm itself is from Oz Solomon.
+counting algorithm itself is from Oz Solomon. I will discuss every of my changes to the code in this article - after all, there aren't so many changes required.
Creating a new AddIn
Our AddIn will be a menu entry in the "Tools" menu that opens a document window
-displaying the line counter UI. SharpDevelop already comes with a project
-template for an AddIn extending the "Tools" menu: "Tools menu entry"
-
+displaying the line counter UI. While it is possible to develop SharpDevelop AddIns in Visual Studio, you can get
+started a lot faster if you use SharpDevelop because it already comes with a project
+template for an AddIn extending the "Tools" menu: "Tools menu entry".
+
-We create a SharpDevelop Macro with the name "LineCounter". The "SharpDevelop
+We create a SharpDevelop AddIn with the name "LineCounter". The "SharpDevelop
AddIn" template could also be used, but it starts with an AddIn defining a pad
(a docked tool window like "Projects", "Properties"); the "Tool menu entry"
AddIn starts with a menu command.
Now let's look at what SharpDevelop has generated for us:
We have a project with a few files:
-
+
First look at the .addin file:
The template already defines a menu item in the tools menu, we'll just modify
the label. And we'll add a new section to the .addin file: the <Manifest>
@@ -69,7 +74,7 @@ item inside a <Condition name="SolutionOpen" action="disable">
Here is how the content of LineCounter.addin should look like after these steps:
<AddIn name = "LineCounter"
author = "Daniel Grunwald"
- url = "http://www.codeproject.com/useritems/LineCounterSharpDevelopAddIn.asp"
+ url = "http://www.codeproject.com/useritems/LineCounterSDAddIn.asp"
description = "Advanced line counter AddIn">
<Manifest>
@@ -92,7 +97,7 @@ Here is how the content of LineCounter.addin should look like after these steps:
</AddIn>
Our menu item uses the "class" attribute. When the menu item is
clicked, SharpDevelop will create an instance of this class and call its Run()
-method. This class is defined the file Command.cs. The example code from the
+method. This class is defined in the file Command.cs. The example code from the
template accesses the currently opened text editor and reverses the letters in
the currently selected text. We are not interested in accessing the text editor,
so we can delete the content of the Run() method and start writing our own.
@@ -105,19 +110,20 @@ about missing references. This is because the template is missing the assembly
references to the SharpDevelop libraries - these have to hard-coded paths in
most cases, so you should add them manually. Add references to
ICSharpCode.Core.dll and ICSharpCode.SharpDevelop.dll from the bin directory of
-your SharpDevelop installation. ICSharpCode.Core contains the AddIn system, we
-need the base class of our menu command from it. ICSharpCode.SharpDevelop is the
-largest part of SharpDevelop, we'll use the project system from it.
+your SharpDevelop installation. ICSharpCode.Core contains the AddIn system,
+and also the base class for our menu command.
+ICSharpCode.SharpDevelop is the largest part of SharpDevelop, it contains
+the project system and many other things.
Make sure you set "Local copy" for the references to
-False.
-
+False.
+
You should now be able to successfully compile the project. If you look into the
bin/Debug directory, you will see a copy of LineCounter.addin, the compiled
LineCounter.dll and the debug symbols.
If you want to test your AddIn, you need to register it with SharpDevelop. The
best way for testing is to copy these files to the AddIns directory of your
-SharpDevelop installation. Restart SharpDevelop to let it load the AddIn. You
+SharpDevelop installation. Restart SharpDevelop to load the AddIn. You
should see the "Line Counter" command in the Tools menu, disabled until you open
a solution. If you click the menu item, the message box should show up.
If you want to update your AddIn, you'll need to shutdown SharpDevelop, copy the
@@ -130,15 +136,15 @@ Visual Studio to write your AddIn...
Now to the real work: Implementing the line counter. We want to display the line
counter user interface as a document, like the start page. Document views in
-SharpDevelop are called ViewContents.
+SharpDevelop are called ViewContents.
There are two types of view contents: primary and secondary. A primary view
content is capable of displaying something on its own; a secondary view content
extends another view content by displaying multiple tabs in the document -
SharpDevelop's Windows.Forms designer is a secondary view content. We want to
display a simple document view, so we'll use a normal (primary) view
-content.
+content.
-Showing such a view content is easy:
+Showing such a view content is easy:
Although the extension process is very different in SharpDevelop and Visual
Studio; the API is quite similar - after all, both are modelling MSBuild
- solutions and after a similar feature set. I hope this shows you that porting
+ solutions and a similar feature set. I hope this shows you that porting
AddIns from Visual Studio to SharpDevelop isn't very hard and we would like to
see more SharpDevelop AddIns in the future.
@@ -282,7 +288,7 @@ m_projIconMappings.Add("{00000001-0000-0000-0000-000000000000}", 5);
Here an image showing the AddIn counting itself:
-
+
Possible improvements
@@ -337,7 +343,7 @@ can add SharpDevelop icons to an existing image list.
}
}
-We
+We
will use two instances of this class to control the two image lists
imgProjectTypes and imgFileTypes.
ScanSolution() is getting the icon index from m_projIconMappings - we will
@@ -419,7 +425,7 @@ name "LineCountingAlgorithm". Don't be irritated that it's not defined in the
XML schema for .addin files - we are creating a new possible codon name here;
the XML schema is just for code completion when editing the .addin file.
Now how can we define this codon type? Constructing objects from the AddInTree
-is done by the doozers (the name comes
+is done by the doozers (the name comes
from
these
guys
@@ -480,8 +486,7 @@ CountingAlgorithmDescriptor. Let's define that class:
}
- Now only the change to LineCounterBrowser to actually use this code is
- missing.
+ Now the LineCounterBrowser code has to be changed to use the code we just wrote.
We will need a member variable storing the list of existing counting algorithms:
List<CountingAlgorithmDescriptor> countingAlgorithms;
@@ -555,7 +560,7 @@ the zip file to "LineCounter.sdaddin". That really was everything you had to do
where you can install the AddIn with just one click. AddIns installed this way
will be extracted to %Application Data%\.ICSharpCode\SharpDevelop2\AddIns.
-
+
More AddIn-writing help
@@ -589,7 +594,7 @@ will be extracted to %Application Data%\.ICSharpCode\SharpDevelop2\AddIns.
Summary
- This article shows you how to start writing SharpDevelop AddIns. It is a
+ This article shows you how to start writing SharpDevelop AddIns. It is a
complete walkthrough from creating a new project to creating the installation
package.
@@ -601,9 +606,7 @@ will be extracted to %Application Data%\.ICSharpCode\SharpDevelop2\AddIns.
18th July, 2006: Article published (based on SharpDevelop
2.0.0.1591).
-
-
-
-
-
+
+
+
+ 
+ 
