Partilhar via

Método Commands2.AddNamedCommand2

  • Artigo

Cria um comando nomeado que é salvo pelo ambiente e disponibilizado na próxima vez em que o ambiente é iniciado, mesmo se o suplemento não está carregado na inicialização do ambiente.

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

Sintaxe

'Declaração
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
    Obrigatório.O AddIn objeto está adicionando o novo comando.
  • Name
    Tipo: System.String
    Obrigatório.A forma abreviada do nome do novo comando.AddNamedCommand2usa o prefácio Addins.Progid. para criar um nome exclusivo.
  • ButtonText
    Tipo: System.String
    Obrigatório.O nome a ser usado se o comando estiver acoplado a um botão que é exibido pelo nome, em vez de fazê-lo por um ícone.
  • Tooltip
    Tipo: System.String
    Obrigatório.O texto exibido quando o usuário posiciona o ponteiro do mouse sobre qualquer controle vinculado a novo comando.
  • MSOButton
    Tipo: System.Boolean
    Obrigatório.Indica como o parâmetro de Bitmap é interpretado.
    Se o valor for true, Bitmap é a identificação de um bitmap de Microsoft Office.
    Se MSOButton é false, em seguida, Bitmap pode ser uma das seguintes opções:
    -ABitmap
    -UmIcon
    -IPicture
    -A identificação de um recurso de bitmap de 16 x 16 (mas não é um recurso de ícone) fornecido pelo suplemento.Visual Studio primeiro irá examinar DLL satélite do add-in.Se o recurso não for encontrado, a DLL do suplemento será pesquisada.
  • Bitmap
    Tipo: System.Object
    Opcional.A identificação de um bitmap para exibir no botão.Consulte MSOButton.
  • ContextUIGUIDs
    Tipo: array<System.Object[]%
    Opcional.Um SafeArray de GUIDs que determina o comando de mostrar os contextos de ambiente (ou seja, o modo de depuração, modo de design e assim por diante).Consulte vsCommandDisabledFlags.
  • vsCommandStatusValue
    Tipo: System.Int32
    Opcional.Determina se o estado desativado do comando é invisível ou cinza quando você fornecer uma ContextUIGUIDs e nenhum está ativo no momento.
  • CommandStyleFlags
    Tipo: System.Int32
    Opcional.Determina o estado do comando quando você fornecer uma ContextUIGUIDs e nenhum dos contextos especificados está ativo no momento.Este parâmetro deve incluir sempre vsCommandStatusSupported.Se ele também inclui vsCommandStatusEnabled, o comando será ativado...

Valor de retorno

Tipo: EnvDTE.Command
O comando nomeado que foi criado.

Comentários

Para obter informações sobre como obter os valores de ID de botões de die de bitmap, consulte Listando Faces do botão na barra de comandos para o sistema de Microsoft Office.

Suplementos posteriormente podem alterar o ButtonText nome respondendo para o QueryStatus método. Se o texto começar com #, o restante da seqüência de caracteres é um inteiro que representa uma ID de recurso registrado DLL satélite do suplemento.

O ContextUIGUIDs parâmetro e o vsCommandStatusValue parâmetro são usados quando o suplemento não está carregado e, portanto, não pode responder ao QueryStatus método. Se ContextUIGUIDs está vazio, e em seguida, o comando está ativado até que o suplemento é carregado e pode responder a QueryStatus.

O suplemento pode receber a notificação de chamada por meio de IDTCommandTarget interface. Um botão pode ser adicionado usando o OnConnection método de IDTExtensibility2 interface.

Segurança do .NET Framework

Consulte também

Referência

Commands2 Interface

Namespace EnvDTE80