Creating a new SSMS Ecosystem Project Plugin

I recently wanted to create an SSMS plugin so I was happy to run across Red Gate’s SSMS ecosystem project. It comes with the C# code for a sample plugin, which is nice. But I couldn’t find any documentation on how to setup a new plugin from strach. It wasn’t hard to figure out though.

One Time Setup

The first thing you need to do is to install the Red Gate SSMS Ecosystem Framework. This only has to be done once – it doesn’t have to be repeated for every plugin you write.

Each Time Setup

Here are the steps to follow in Visual Studio for every plugin you create:

1) Create a new Class Library

2) Search Nuget for “Redgate SSMS” and install the RedGate.SIPFrameworkShared package.

3) Rename Class1 to something more fitting.

4) At the top of your code add “using RedGate.SIPSharedFramework”.

5) Create a registry entry for your plugin. The location will depend on whether you’re running a 32-bit or 64-bit version of Windows.

32-bit: HKLM\SOFTWARE\Red Gate\SIPFramework\Plugins

64-bit: HKLM\SOFTWARE\Wow6432Node\Red Gate\SIPFramework\Plugins

At this location create a new String Value. Name it the name of your plugin. Then make the value the path to your project’s dll.

6) Modify your class to inherit from ISsmsAddin4

7) Implement the members of this interface.  

    
    public class MyPlugin : ISsmsAddin4
    {
        public string Version { get { return "1.0.0.0"; } }
        public string Description { get { return "Your add-in's description"; } }
        public string Name { get { return "Your add-in's name"; } }
        public string Author { get { return "Plugin Author"; } }
        public string Url { get { return @"https://example.com"; } }

        public void OnShutdown()
        {
            // Your code here
        }

        public void OnLoad(ISsmsExtendedFunctionalityProvider provider)
        {
            // Your code here
        }

        public void OnNodeChanged(ObjectExplorerNodeDescriptorBase node)
        {
            // Your code here 
        }
    }

 

8) Using the code Red Gate’s sample add-in as your guide, you can now begin to create your plugin.

See the Red Gate website for more information on debugging your plugin.

Comments

Post a Comment

Popular posts from this blog

Restoring Color Icons in Gimp 2.10

Image
When Gimp 2.10 was released, the new icons for the toolbox items were all black and white. If, like me, you'd like to go back to the color versions, here's how:  Select Edit --> Preferences From the Preferences dialog, under the Interface section, select Icon Theme For the icon theme, select Legacy if you want icons like they were in 2.8.  If you'd like color versions of the new icons, select the icon theme named  Color . 
Read more

My Nullable DateTime Picker

Image
I needed to bind a nullable DateTime to a Winforms DateTimePicker control. Unfortunately, the standard DateTimePicker only supports regular DateTime objects. I looked around and found some controls that other people had built, but none of them did exactly what I needed.  I wanted a control where, if the checkbox is unchecked, the value is considered null and the box is blanked out. I couldn’t find one like that, so I built my own. The first one I built was written in VB.Net. In this blog post, we'll create a C# version.  We start by creating a new class and having it inherit from DateTimePicker.  using System.Windows.Forms; namespace NullableSample { public class NullableDateTimePicker : DateTimePicker { } } Then add a nullable DateTime property to hold the binded value.  public class NullableDateTimePicker : DateTimePicker { public DateTime? BindedValue { get; set; } } In the constructor, we set the ShowCheckBox value to true because we want it
Read more

PowerBuilder and SQL Server: Tips On Working Together

I recently worked on a project that used PowerBuilder for the front end and SQL Server for the database. I've worked with both of these technologies in the past but this was the first time I used them together. Below are some notes about the things that I learned regarding PB and SQL Server working together. Single Quoted Strings If you do any work with SQL statements in SQL Server Management Studio (SSMS), you'll find that SQL Server only accepts strings if they are surrounded by single quotes. You can use double quotes in the PowerBuilder painters and they'll get translated properly on their way to SQL Server. But you may want to just go ahead and use single quotes everywhere, especially if you are trying to track down a problem by copying SQL from PowerBuilder and pasting it into SSMS. Identity Columns One of my tables had its primary key set in SQL Server to autoincrement. In my datawindow I would insert a row and then do an update. I was expecting the value SQL Server
Read more