Add a Toolbar

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

This walkthrough shows how to add a toolbar to the Visual Studio IDE.

A toolbar is a horizontal or vertical strip that contains buttons that are bound to commands. Depending on its implementation, a toolbar in the IDE can be repositioned, docked on any side of the main IDE window, or made to stay in front of other windows.

In addition, users can add commands to a toolbar or remove them from it by using the Customize dialog box. Typically, toolbars in VSPackages are user-customizable. The IDE handles all customization, and the VSPackage responds to commands. The VSPackage does not have to know where a command is physically located.

For more information about menus, see Commands, menus, and toolbars.

Prerequisites

Starting in Visual Studio 2015, you do not install the Visual Studio SDK from the download center. It is included as an optional feature in Visual Studio setup. You can also install the VS SDK later on. For more information, see Install the Visual Studio SDK.

Create an extension with a toolbar

Create a VSIX project named IDEToolbar. Add a menu command item template named ToolbarTestCommand. For information about how to do this, see Create an extension with a menu command.

Create a toolbar for the IDE

1. In ToolbarTestCommandPackage.vsct, look for the Symbols section. In the GuidSymbol element named guidToolbarTestCommandPackageCmdSet, add declarations for a toolbar and a toolbar group, as follows.

   <IDSymbol name="Toolbar" value="0x1000" />
   <IDSymbol name="ToolbarGroup" value="0x1050" />
   
   

2. At the top of the Commands section, create a Menus section. Add a Menu element to the Menus section to define your toolbar.

   <Menus>
       <Menu guid="guidToolbarTestCommandPackageCmdSet" id="Toolbar"
           type="Toolbar" >
           <CommandFlag>DefaultDocked</CommandFlag>
           <Strings>
               <ButtonText>Test Toolbar</ButtonText>
               <CommandName>Test Toolbar</CommandName>
           </Strings>
         </Menu>
   </Menus>
   

   Toolbars cannot be nested like submenus. Therefore, you do not have to assign a parent group. Also, you do not have to set a priority, because the user can move toolbars. Typically, initial placement of a toolbar is defined programmatically, but subsequent changes by the user are persisted.

3. In the Groups section, after the existing group entry, define a Group element to contain the commands for the toolbar.

   <Group guid="guidToolbarTestCommandPackageCmdSet" id="ToolbarGroup"
         priority="0x0000">
     <Parent guid="guidToolbarTestCommandPackageCmdSet" id="Toolbar"/>
   </Group>
   

4. Make the button appear on the toolbar. In the Buttons section, replace the Parent block in the Button to the toolbar. The resulting Button block should look like this:

   <Button guid="guidToolbarTestCommandPackageCmdSet" id="ToolbarTestCommandId" priority="0x0100" type="Button">
       <Parent guid= "guidToolbarTestCommandPackageCmdSet" id="ToolbarGroup" />
               <Icon guid="guidImages" id="bmpPic1" />
       <Strings>
           <ButtonText>Invoke ToolbarTestCommand</ButtonText>
       </Strings>
   </Button>
   

   By default, if a toolbar has no commands, it does not appear.

5. Build the project and start debugging. The experimental instance should appear.

6. Right-click the Visual Studio menu bar to get the list of toolbars. Select Test Toolbar.

7. You should now see your toolbar as an icon to the right of the Find in Files icon. When you click the icon, you should see a message box that says ToolbarTestCommandPackage. Inside IDEToolbar.ToolbarTestCommand.MenuItemCallback().

See also

• Commands, menus, and toolbars