Método Commands.AddCommandBar

Artigo
05/17/2015

Cria uma barra de comandos que é salvo e disponível o ambiente é iniciado na próxima vez.

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

Necessário. Um nome para a nova barra de comandos.

Type
Tipo: EnvDTE.vsCommandBarType

Necessário. Uma constante de vsCommandBarType que determina o tipo da barra de comandos:

CommandBarParent
Tipo: Object

Opcional. Um objeto do Office CommandBar ao qual a nova barra de comandos deve ser adicionada. (Isso é necessário, porém, se Type é vsCommandBarTypeMenu.)

Position
Tipo: Int32

Opcional. A posição do índice, a partir de uma, na barra de comandos para colocar a nova barra de comandos.

Valor de retorno

Tipo: Object
Um objeto CommandBar.

Comentários

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

A barra de comandos adicionada usando este método é uma barra de comandos permanente, que está disponível em cada sessão do IDE mesmo se o suplemento é carregado. Você deve usar esse método para adicionar uma barra de comandos somente se você quiser uma barra de comandos permanente. Você deve chamar esse método apenas uma vez, quando o suplemento é carregado pela primeira vez. Se você quiser uma barra de comandos temporária, exibida apenas quando o suplemento é carregado na verdade, você deve usar o método de DTE.CommandBars.Add quando você carrega o suplemento, e chame o método de DTE.CommandBars.Remove quando você descarregar o suplemento.

Desde que uma barra de comandos permanente aparece mesmo quando o suplemento não são carregados, você deve ter a certeza de removê-la quando o suplemento é desinstalado. Em virtude disso, você deve usar um MSI para instalar e desinstalar o suplemento, e adiciona uma ação personalizada para seu programa de desinstalação.

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

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

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

Commands Interface

Namespace EnvDTE

Compartilhar via