Partilhar via

Método Commands.AddCommandBar

  • Artigo

Cria uma barra de comando é salvas e estarão disponíveis na próxima vez em que o ambiente é iniciado.

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

Sintaxe

'Declaração
Function AddCommandBar ( _
    Name As String, _
    Type As vsCommandBarType, _
    CommandBarParent As Object, _
    Position As Integer _
) As Object

Object AddCommandBar(
    string Name,
    vsCommandBarType Type,
    Object CommandBarParent,
    int Position
)

Object^ AddCommandBar(
    [InAttribute] String^ Name, 
    [InAttribute] vsCommandBarType Type, 
    [InAttribute] Object^ CommandBarParent, 
    [InAttribute] int Position
)

abstract AddCommandBar : 
        Name:string * 
        Type:vsCommandBarType * 
        CommandBarParent:Object * 
        Position:int -> Object 

function AddCommandBar(
    Name : String, 
    Type : vsCommandBarType, 
    CommandBarParent : Object, 
    Position : int
) : Object

Parâmetros

  • Name
    Tipo: System.String
    Obrigatório.Um nome para a nova barra de comando.
  • Position
    Tipo: System.Int32
    Opcional.A posição de índice, começando em uma, na barra de comando para colocar a nova barra de comando.

Valor de retorno

Tipo: System.Object
A CommandBar objeto.

Comentários

O CommandBar objeto é um membro de modelo de objeto Microsoft Office.

A barra de comandos adicionada usando esse método é uma barra de comandos permanente, o que está disponível em cada sessão do IDE ou não o suplemento é carregado. Você deve usar esse método para adicionar uma barra de comando apenas se você quiser uma barra de comandos permanente. Você deve chamar este método apenas uma vez, quando seu suplemento é carregado pela primeira vez. Se você quiser uma barra de comandos temporárias, que aparece somente quando o suplemento é carregado, você deve usar o DTE.CommandBars.Add método quando você carrega o suplemento e chamar DTE.CommandBars.Remove método quando você descarregar o add-in.

Já que uma barra de comandos permanente parece mesmo quando o suplemento não está carregado, deve certificar-se de removê-lo quando o suplemento é desinstalado. Portanto, você deve usar um MSI para instalar e desinstalar o add-in e adicione uma ação personalizada para o seu programa de desinstalação.

Para obter mais informações sobre como adicionar e remover barras de comando permanentes e temporários, consulte HOWTO: Adicionando botões, barras de ferramentas e de commandbars para Visual Studio.NET a partir de um add-in e HOWTO: Removendo os comandos e os elementos de interface do usuário durante a Visual Studio.NET desinstalação do suplemento.

Exemplos

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddCommandBarExample()
   ' 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 customin, customout As Object
   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.
   cmdbarobj = cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj = cmds.AddNamedCommand(colAddins.Item(1), "mycommand", _
   "mycommand", "tooltip for mycommand", True)
End Sub

Segurança do .NET Framework

Consulte também

Referência

Commands Interface

Namespace EnvDTE