How to Know the GUID and CommandId for the Object Explorer > Tables in SSMS

ciboligi ijavima 20 Reputation points
2024-02-28T05:40:40.6333333+00:00

I am creating an extension for SSMS, which I need to display when i right click on the any table of the Object Explorer in SSMS.

What I have done till now:

  1. I have Created a VSIX Project, add a new command for that.
  2. changed the VSCT for the same.
  3. Changed Properties > Debug : start a external program => to ssms.exe path
  4. Changed Properties > VSIX > checked the checkbox for => "copy VSIX content to the following location" > in the input filed added the extension folder path in the SSMS folder

=> after this when I run my project, everything works fine and SSMS gets opened immediately, also I can see my extension when I right click on the query window.

I took reference from one site which helped me displayed the extension in the query window (when I right clicked it). Now since i want my extension to be display when i right click on the Tables of the Object Explorer in SSMS. I know i need to change the GUID and CommandID for this specific one :

I am sharing my .vsct file:

<?xml version="1.0" encoding="utf-8"?>
<CommandTable xmlns="http://schemas.microsoft.com/VisualStudio/2005-10-18/CommandTable" xmlns:xs="http://www.w3.org/2001/XMLSchema">

	<!--  This is the file that defines the actual layout and type of the commands.
        It is divided in different sections (e.g. command definition, command
        placement, ...), with each defining a specific set of properties.
        See the comment before each section for more details about how to
        use it. -->

	<!--  The VSCT compiler (the tool that translates this file into the binary
        format that VisualStudio will consume) has the ability to run a preprocessor
        on the vsct file; this preprocessor is (usually) the C++ preprocessor, so
        it is possible to define includes and macros with the same syntax used
        in C++ files. Using this ability of the compiler here, we include some files
        defining some of the constants that we will use inside the file. -->

	<!--This is the file that defines the IDs for all the commands exposed by VisualStudio. -->
	<Extern href="stdidcmd.h"/>

	<!--This header contains the command ids for the menus provided by the shell. -->
	<Extern href="vsshlids.h"/>

	<!--The Commands section is where commands, menus, and menu groups are defined.
      This section uses a Guid to identify the package that provides the command defined inside it. -->
	<Commands package="guidPasteCommandPackage">
		<!-- Inside this section we have different sub-sections: one for the menus, another
    for the menu groups, one for the buttons (the actual commands), one for the combos
    and the last one for the bitmaps used. Each element is identified by a command id that
    is a unique pair of guid and numeric identifier; the guid part of the identifier is usually
    called "command set" and is used to group different command inside a logically related
    group; your package should define its own command set in order to avoid collisions
    with command ids defined by other packages. -->

		<!-- In this section you can define new menu groups. A menu group is a container for
         other menus or buttons (commands); from a visual point of view you can see the
         group as the part of a menu contained between two lines. The parent of a group
         must be a menu. -->
		<Groups>
			<Group guid="guidPasteCommandPackageCmdSet" id="MyMenuGroup" priority="0x0201">
				<Parent guid="queryWindowContextCommandSet" id="queryWindowContextMenus"/>
			</Group>
		</Groups>

		<!--Buttons section. -->
		<!--This section defines the elements the user can interact with, like a menu command or a button
        or combo box in a toolbar. -->
		<Buttons>
			<!--To define a menu group you have to specify its ID, the parent menu and its display priority.
          The command is visible and enabled by default. If you need to change the visibility, status, etc, you can use
          the CommandFlag node.
          You can add more than one CommandFlag node e.g.:
              <CommandFlag>DefaultInvisible</CommandFlag>
              <CommandFlag>DynamicVisibility</CommandFlag>
          If you do not want an image next to your command, remove the Icon node /> -->
			<Button guid="guidPasteCommandPackageCmdSet" id="PasteCommandId" priority="0x0100" type="Button">
				<Parent guid="guidPasteCommandPackageCmdSet" id="MyMenuGroup" />
				<Icon guid="guidIcons" id="icon1" />
				<Strings>
					<ButtonText>Paste as CSV</ButtonText>
				</Strings>
			</Button>
		</Buttons>

		<!--The bitmaps section is used to define the bitmaps that are used for the commands.-->
		<Bitmaps>
			<!--  The bitmap id is defined in a way that is a little bit different from the others:
            the declaration starts with a guid for the bitmap strip, then there is the resource id of the
            bitmap strip containing the bitmaps and then there are the numeric ids of the elements used
            inside a button definition. An important aspect of this declaration is that the element id
            must be the actual index (1-based) of the bitmap inside the bitmap strip. -->
			<Bitmap guid="guidImages" href="Resources\PasteCommand.png" usedList="bmpPic1, bmpPic2, bmpPicSearch, bmpPicX, bmpPicArrows, bmpPicStrikethrough"/>

			<Bitmap guid="guidIcons" href="Resources\Icon.png" usedList="icon1"/>
		</Bitmaps>
	</Commands>

	<Symbols>
		<!-- This is the package guid. -->
		<GuidSymbol name="guidPasteCommandPackage" value="{d0d6d2a0-c81f-48ee-b00f-c5a6a318967b}" />

		<!-- This is the guid used to group the menu commands together -->
		<GuidSymbol name="guidPasteCommandPackageCmdSet" value="{dff28a75-44f3-47c0-9659-a745e4e11873}">
			<IDSymbol name="MyMenuGroup" value="0x1020" />
			<IDSymbol name="PasteCommandId" value="0x0100" />
		</GuidSymbol>

		<GuidSymbol name="guidImages" value="{f8597cd5-8c71-4100-893d-e37199b4d221}" >
			<IDSymbol name="bmpPic1" value="1" />
			<IDSymbol name="bmpPic2" value="2" />
			<IDSymbol name="bmpPicSearch" value="3" />
			<IDSymbol name="bmpPicX" value="4" />
			<IDSymbol name="bmpPicArrows" value="5" />
			<IDSymbol name="bmpPicStrikethrough" value="6" />
		</GuidSymbol>

		<GuidSymbol name="queryWindowContextCommandSet" value="{33F13AC3-80BB-4ECB-85BC-225435603A5E}">
			<IDSymbol name="queryWindowContextMenus" value="0x0050"/>
		</GuidSymbol>

		<GuidSymbol name="guidIcons" value="{20C1E9DD-E9B4-4819-BAEC-F66127790A16}">
			<IDSymbol name="icon1" value="1" />
		</GuidSymbol>

	</Symbols>
</CommandTable>

here in the 4th GuidSymbol i need to change the value of GuidSymbol and value of IDSymbol

<GuidSymbol name="queryWindowContextCommandSet" value="{33F13AC3-80BB-4ECB-85BC-225435603A5E}">
			<IDSymbol name="queryWindowContextMenus" value="0x0050"/>
</GuidSymbol>

I also have configure my visual Studio , when I do => CLTR + Shift + right click => then i get the GUID and other commandID values for the particular thing but all of these are for the visual Studio .

=> below is the extension displayed in the query window when i right click on this.

User's image

=> below is the the place where i need my extension to be displayed:
User's image

NOTE: I am using Visual Studio 2017 and SSMS v18.4 (15.018206.0), also wanted to do this in these versions only, so don't suggest try new version.

Please Help me with this.
Thank You.

Visual Studio
Visual Studio
A family of Microsoft suites of integrated development tools for building applications for Windows, the web and mobile devices.
4,821 questions
SQL Server
SQL Server
A family of Microsoft relational database management and analysis systems for e-commerce, line-of-business, and data warehousing solutions.
13,203 questions
Visual Studio Extensions
Visual Studio Extensions
Visual Studio: A family of Microsoft suites of integrated development tools for building applications for Windows, the web and mobile devices.Extensions: A program or program module that adds functionality to or extends the effectiveness of a program.
189 questions
{count} votes