Compartir a través de

Commands.AddNamedCommand (Método)

  • Artículo

Crea un comando con nombre que es guardado por el entorno y está disponible la próxima vez que se inicia éste, aun cuando no esté cargado el complemento al iniciarse el entorno.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
Function AddNamedCommand ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Integer, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandDisabledFlagsValue As Integer _
) As Command

Command AddNamedCommand(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    int Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandDisabledFlagsValue
)

Command^ AddNamedCommand(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] int Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandDisabledFlagsValue
)

abstract AddNamedCommand : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:int * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandDisabledFlagsValue:int -> Command 

function AddNamedCommand(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : int, 
    ContextUIGUIDs : Object[], 
    vsCommandDisabledFlagsValue : int
) : Command

Parámetros

  • AddInInstance
    Tipo: EnvDTE.AddIn
    Obligatorio.El objeto AddIn agrega el nuevo comando.
  • Name
    Tipo: System.String
    Obligatorio.La forma abreviada del nombre para el nuevo comando.AddNamedCommand le antepone Addins.Progid. para crear un nombre único.
  • ButtonText
    Tipo: System.String
    Obligatorio.Nombre que se usará si el comando está enlazado a un botón que se muestra por nombre en lugar de por icono.
  • Tooltip
    Tipo: System.String
    Obligatorio.Texto mostrado cuando un usuario mantiene el puntero del mouse sobre cualquier control enlazado con el nuevo comando.
  • MSOButton
    Tipo: System.Boolean
    Obligatorio.Indica si la imagen de botón del comando con nombre es una imagen de Office.True = botón.Si MSOButton es False, entonces Bitmap será el identificador de un recurso de mapa de bits de 16x16 (no de un recurso de icono) situado en una DLL de recursos de Visual C++ que deberá residir en una carpeta junto al identificador de la configuración regional de idioma (1033 para inglés).
  • Bitmap
    Tipo: System.Int32
    Opcional.Identificador del mapa de bits que se mostrará en el botón.
  • ContextUIGUIDs
    Tipo: array<System.Object[]%
    Opcional.Un objeto SafeArray de identificadores únicos globales (GUID) que determina qué contextos de entorno (modo de depuración, modo de diseño, etc.) muestran el comando.Vea vsCommandDisabledFlags.

Valor devuelto

Tipo: EnvDTE.Command
Un objeto Command.

Comentarios

Los complementos pueden cambiar posteriormente el nombre de ButtonText respondiendo al método QueryStatus. Si el texto comienza con "#", el resto de la cadena es un entero que representa el identificador de recurso de la DLL satélite registrada para el complemento.

El parámetro ContextUIGUIDs y el parámetro vsCommandStatusValue se emplean cuando no está cargado el complemento y, por ello, no puede responder al método QueryStatus. Si ContextUIGUIDs está vacío, el comando estará siempre habilitado hasta que se cargue el complemento y pueda responder al método QueryStatus.

El complemento puede recibir notificación de llamadas a través de la interfaz IDTCommandTarget. Se puede agregar un botón utilizando el método OnConnection de la interfaz IDTExtensibility2

Ejemplos

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddControlExample()
   ' Before running, you must add a reference to the Office 
   ' typelib to gain access to the CommandBar object. Also, for this 
   ' example to work correctly, there should be an add-in available 
   ' in the Visual Studio environment.
   Dim cmds As Commands
   Dim cmdobj As Command
   Dim cmdbarobj As CommandBar
   Dim colAddins As AddIns

   ' Set references.
   colAddins = DTE.AddIns()
   cmds = DTE.Commands
   cmdobj = cmds.Item("File.NewFile")

   ' Create a toolbar and add the File.NewFile command to it.
   cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj.AddControl(cmdbarobj)
   cmds.AddNamedCommand(colAddins.Item(1), "MyCommand", _
   "Button Text", "Some tooltip", True)
End Sub

Seguridad de .NET Framework

Vea también

Referencia

Commands Interfaz

EnvDTE (Espacio de nombres)