How to: Add and Handle Commands
Visual Studio add-ins are deprecated in Visual Studio 2013. You should upgrade your add-ins to VSPackage extensions. For more information about upgrading, see FAQ: Converting Add-ins to VSPackage Extensions.
The following objects allow you to create, handle, and manipulate commands on Visual Studio menus and toolbars.
|
Object Name |
Description |
|---|---|
|
Provides methods to determine the status of, or execute, a command added to the integrated development environment (IDE) by using the AddNamedCommand2 method. |
|
|
Represents all commands in the IDE. |
|
|
Represents a command in the IDE. |
|
|
Provides command events for add-ins. |
|
|
Provides a Click event for when a control on a command bar is clicked. |
Note
|
|---|
|
If your command no longer appears on the appropriate command bar, or if you add a new command or modify an existing command, or if you would like to recreate the command, close all instances of Visual Studio and double-click the file named ReCreateCommands.reg in the folder containing the source code for your Add-in. |
Using these objects, you can:
-
Add or remove a command bar in the Visual Studio IDE (AddCommandBar and RemoveCommandBar methods).
-
Add a new named command to a toolbar or menu (AddNamedCommand2 method).
-
Obtain the status of a command (CommandInfo and QueryStatus methods).
Note
You cannot connect a CommandBarEvents event for CommandBar controls that were created for a new command added through AddNamedCommand2.
|
Note
|
|---|
|
The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. These procedures were developed with the General Development Settings active. To change your settings, choose Import and Export Settings on the Tools menu. For more information, see Customizing Development Settings in Visual Studio. |
The following example uses:
-
The Command object.
-
The AddNamedCommand method.
-
The AddControl method.
-
The IDTCommandTarget interface.
-
The IDTCommandTarget::Exec method.
-
The IDTCommandTarget::QueryStatus method.
The procedure demonstrates how to make an add-in appear as a command on the Tools menu in Visual Studio. Add the first section of code to the OnConnection method of the add-in you create. In the Exec and QueryStatus methods, make sure that the line, If cmdName = "MyAddin1.Connect.MyAddin1" Then, reflects the name of your add-in.