Commands2.AddNamedCommand2 Method

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

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Function AddNamedCommand2 ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Object, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandStatusValue As Integer, _
    CommandStyleFlags As Integer, _
    ControlType As vsCommandControlType _
) As Command

Command AddNamedCommand2(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    Object Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandStatusValue,
    int CommandStyleFlags,
    vsCommandControlType ControlType
)

Command^ AddNamedCommand2(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] Object^ Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandStatusValue, 
    [InAttribute] int CommandStyleFlags, 
    [InAttribute] vsCommandControlType ControlType
)

abstract AddNamedCommand2 : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:Object * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandStatusValue:int * 
        CommandStyleFlags:int * 
        ControlType:vsCommandControlType -> Command

function AddNamedCommand2(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : Object, 
    ContextUIGUIDs : Object[], 
    vsCommandStatusValue : int, 
    CommandStyleFlags : int, 
    ControlType : vsCommandControlType
) : Command

Parameters

• AddInInstance
  Type: EnvDTE.AddIn

  Required. The AddIn that is adding the new command.

• Name
  Type: System.String

  Required. The short form of the name for your new command. AddNamedCommand2 uses the preface Addins.Progid. to create a unique name.

• ButtonText
  Type: System.String

  Required. The name to show in the UI for this command.

• Tooltip
  Type: System.String

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

• MSOButton
  Type: System.Boolean

  Required. Must be false.

• Bitmap
  Type: System.Object

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

  Bitmap can be one of the following:

  - A Bitmap

  - An Icon

  - An IPicture

  - The ID of a 16x16 bitmap resource (but not an icon resource) that is provided by the add-in. Visual Studio looks first in the add-in's satellite DLL. If the resource is not found there, the add-in DLL will be searched.

• ContextUIGUIDs
  Type: array<System.Object[]%

  Optional. The GUIDs that determine which environment contexts (that is, debug mode, design mode, and so on) show the command.

• vsCommandStatusValue
  Type: System.Int32

  Optional. Determines whether the disabled state of the command is invisible or disabled when you supply a ContextUIGUIDs parameter and none are currently active. See vsCommandDisabledFlags.

• CommandStyleFlags
  Type: System.Int32

  Optional. One of the vsCommandStyle flags, in particular vsCommandStylePict, vsCommandStylePictAndText, or vsCommandStyleText.

• ControlType
  Type: EnvDTE80.vsCommandControlType

  Optional. Defines the control type added when the UI is created.

Return Value

Type: EnvDTE.Command
The named command that was created.

Remarks

Add-ins 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 Add-in's registered satellite DLL.

There are two default command states: the default enabled state and the default visibility state. These default states are important if a command handler cannot be found (because the component isn't loaded or doesn't implement IDTCommandTarget). If your component is loaded and implements IDTCommandTarget, the default values never apply.

There are two interesting cases where default states are used:

1. You provide UI context GUIDs via the ContextUIGUIDs parameter. In this case visibility is entirely determined by the supplied context GUIDS. If the context is active, then your command is visible, otherwise it is hidden. Enabled state is entirely determined by the default values. By default in Visual Studio a command is always enabled if you pass vsCommandDisabledFlagsGrey then your default state will be disabled. If you pass vsCommandDisabledFlagsEnabled, or you simply don't supply this parameter, then your default state is enabled.

2. You do not provide UI context GUIDs via the ContextUIGUIDs parameter. In this case visibility is based on the flags you pass to vsCommandStatusValue or the default state. Default command visibility in VS is to be visible. If you pass vsCommandDisabledFlagsHidden here, the default is invisible. Enabled state is the same here as it is in case 1 above (determined by the flags and/or default VS behavior).

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Commands2 Interface

EnvDTE80 Namespace