Compartir a través de

Commands2.AddNamedCommand2 (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:  EnvDTE80
Ensamblado:  EnvDTE80 (en EnvDTE80.dll)

Sintaxis

'Declaración
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

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.AddNamedCommand2 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 cómo se interpreta el parámetro Bitmap.
    Si el valor es true, Bitmap es el identificador de un mapa de bits de Microsoft Office.
    Si MSOButton es false, entonces Bitmap puede ser uno de los siguientes:
    - Un objeto Bitmap
    - Un objeto Icon
    - Una interfaz IPicture
    - Id. de un recurso de mapa de bits de 16x16 (pero no de un recurso de icono) proporcionado por el complemento.Visual Studio buscará primero en el archivo DLL satélite del complemento.Si no se encuentra el recurso, se buscará el archivo DLL del complemento.
  • Bitmap
    Tipo: System.Object
    Opcional.Identificador del mapa de bits que se mostrará en el botón.Vea MSOButton.
  • 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.
  • vsCommandStatusValue
    Tipo: System.Int32
    Opcional.Determina si el estado deshabilitado del comando será oculto o atenuado (en gris) cuando se proporciona un valor ContextUIGUIDs y no hay ninguno activo.
  • CommandStyleFlags
    Tipo: System.Int32
    Opcional.Determina el estado del comando cuando se proporciona un valor ContextUIGUIDs y ninguno de los contextos especificados está activo actualmente.Este parámetro siempre debe incluir vsCommandStatusSupported.Si también incluye vsCommandStatusEnabled, el comando estará habilitado.

Valor devuelto

Tipo: EnvDTE.Command
El comando con nombre que se creó.

Comentarios

Para obtener información sobre cómo obtener valores de id. de mapa de bits de botones MSO, vea Listing Button Faces in the Command Bar for the Microsoft Office System.

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 pueden agregar botones mediante el método OnConnection de la interfaz IDTExtensibility2.

Seguridad de .NET Framework

Vea también

Referencia

Commands2 Interfaz

EnvDTE80 (Espacio de nombres)