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: AddIn

    Obligatorio. AddIn que está agregando el nuevo comando.

  • Name
    Tipo: String

    Obligatorio. La forma abreviada del nombre para el nuevo comando. AddNamedCommand2 le antepone Addins.Progid. para crear un nombre único.

  • ButtonText
    Tipo: String

    Obligatorio. El nombre para mostrar en la interfaz de usuario para este comando.

  • Tooltip
    Tipo: String

    Obligatorio. Texto mostrado cuando un usuario mantiene el puntero del mouse sobre cualquier control enlazado con el nuevo comando.

  • MSOButton
    Tipo: Boolean

    Obligatorio. Debe ser false.

  • Bitmap
    Tipo: Object

    Opcional. Identificador del mapa de bits que se mostrará en el botón.

    Bitmap puede ser una de las 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 busca primero en el archivo DLL satélite de complemento. Si no se encuentra el recurso, se buscará el archivo DLL del complemento.

  • ContextUIGUIDs
    Tipo: array<Object[]%

    Opcional. El GUID que determina los contextos de entorno (es decir, modo de depuración, el modo de diseño, etc.) aparece un comando.

  • vsCommandStatusValue
    Tipo: Int32

    Opcional. Determina si el estado deshabilitado de comando es cuando se proporciona un parámetro de ContextUIGUIDs y cualquier está actualmente activa invisible o deshabilitado. Vea vsCommandDisabledFlags.

Valor devuelto

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

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.

Hay dos estados de comando predeterminadas: el estado habilitada predeterminado y el estado predeterminado de visibilidad. Estos estados predeterminadas son importantes si un controlador de comandos no se encuentra (porque el componente no se carga ni implementa IDTCommandTarget). Si el componente se cargará y implementa IDTCommandTarget, los valores predeterminados nunca se aplican.

Hay dos casos interesantes donde utilizan los estados predeterminadas:

  1. Se proporciona el contexto GUID de la interfaz de usuario mediante el parámetro de ContextUIGUIDs . En este caso la visibilidad está determinada por completo del contexto proporcionado GUIDS. Si el contexto está activo, el comando es visible, si no se oculta. Los valores predeterminados determina el estado habilitado completamente. De forma predeterminada en Visual Studio permiten a un comando siempre si pasa vsCommandDisabledFlagsGrey a que se deshabilitará el estado predeterminada. Si pasa vsCommandDisabledFlagsEnabled, o no se proporciona simplemente este parámetro, se habilitan al estado predeterminado.

  2. No proporciona el contexto GUID de la interfaz de usuario mediante el parámetro de ContextUIGUIDs . En este caso la visibilidad se basa en los marcadores que se pasa a vsCommandStatusValue o el estado predeterminada. Visibilidad predeterminada de comando en VS es visibles. Si pasa vsCommandDisabledFlagsHidden aquí, el valor predeterminado es invisible. El estado habilitado es igual aquí que en caso de que 1 anteriormente (determinado por los marcadores o el valor predeterminado de VS comportamiento).

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)