Commands.AddNamedCommand(AddIn, String, String, String, Boolean, Int32, Object[], Int32) Method

Definition

Creates a named command that is saved by the environment and made available the next time the environment starts, even if the VSPackage is not loaded on environment startup.

Add-ins are now deprecated. For more information, see FAQ: Converting Add-ins to VSPackage Extensions.

[System.Runtime.InteropServices.DispId(11)]
public EnvDTE.Command AddNamedCommand (EnvDTE.AddIn AddInInstance, string Name, string ButtonText, string Tooltip, bool MSOButton, int Bitmap = 0, ref object[] ContextUIGUIDs, int vsCommandDisabledFlagsValue = 16);
Parameters
AddInInstance
AddIn

Required. The AddIn that adds the new command.

Name
String

Required. The short form of the name for your new command. AddNamedCommand(AddIn, String, String, String, Boolean, Int32, Object[], Int32) uses the preface Addins.Progid. to create a unique name.

ButtonText
String

Required. The name to use if the command is bound to a button that is displayed by name rather than by icon.

Tooltip
String

Required. The text displayed when a user hovers the mouse pointer over any control bound to the new command.

MSOButton
Boolean

Required. Indicates whether the named command's button picture is an Office picture. True = button. If MSOButton is False, then Bitmap is the ID of a 16x16 bitmap resource (but not an icon resource) in a Visual C++ resource DLL that must reside in a folder with the language's locale identifier (1033 for English).

Bitmap
Int32

Optional. The ID of a bitmap to display on the button.

ContextUIGUIDs
Object[]

Optional. A SafeArray of GUIDs that determines which environment contexts (that is, debug mode, design mode, and so on) show the command. See vsCommandDisabledFlags..

vsCommandDisabledFlagsValue
Int32
Returns

A Command object.

Remarks

You can later change the ButtonText name by responding to the QueryStatus method. If the text begins with "#", then the rest of the string is an integer that represents a resource ID in the registered satellite DLL.

The ContextUIGUIDs parameter and the vsCommandStatusValue parameter are used when the addin is not loaded and thus cannot respond to the QueryStatus method. If ContextUIGUIDs is empty, then the command is enabled until the addin is loaded and can respond to QueryStatus.

The VSPackage can receive invocation notification through the IDTCommandTarget interface. A button can be added by using the OnConnection method of the IDTExtensibility2 interface

Applies to