Método Commands.AddNamedCommand

Cria um comando nomeado que é salvo pelo ambiente e fica disponível na próxima vez que o ambiente começar, mesmo se o suplemento não é carregado na inicialização do ambiente.

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

Sintaxe

'Declaração
Function AddNamedCommand ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Integer, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandDisabledFlagsValue As Integer _
) As Command

Command AddNamedCommand(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    int Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandDisabledFlagsValue
)

Command^ AddNamedCommand(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] int Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandDisabledFlagsValue
)

abstract AddNamedCommand : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:int * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandDisabledFlagsValue:int -> Command

function AddNamedCommand(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : int, 
    ContextUIGUIDs : Object[], 
    vsCommandDisabledFlagsValue : int
) : Command

Parâmetros

• AddInInstance
  Tipo: EnvDTE.AddIn

  Necessário. O objeto de AddIn está adicionando o novo comando.

• Name
  Tipo: String

  Necessário. A forma reduzida do nome de seu novo comando. oAddNamedCommand usa precede Addins.Progid. para criar um nome exclusivo.

• ButtonText
  Tipo: String

  Necessário. O nome a ser usado se o comando é associado a um botão que seja exibido por nome em vez do ícone.

• Tooltip
  Tipo: String

  Necessário. O texto exibido quando um usuário passar o ponteiro de mouse sobre qualquer limite de controle para o novo comando.

• MSOButton
  Tipo: Boolean

  Necessário. Indica se a imagem nomeada do botão de comando é uma imagem do Office. True = botão. Se MSOButton é False, então Bitmap é a ID de um recurso de bitmap 16x16 (mas não de um recurso de ícone) em uma DLL de recursos do Visual C++ que deve residir em uma pasta com o identificador de localidade (1033 para inglês).

• Bitmap
  Tipo: Int32

  Opcional. A ID de um bitmap para exibir no botão.

• ContextUIGUIDs
  Tipo: array<Object[]%

  Opcional. Um SafeArray dos GUIDs que determina quais contextos de ambiente (isto é, o modo de depuração, modo de design, e assim por diante) mostrar o comando. Consulte. vsCommandDisabledFlags.

• vsCommandDisabledFlagsValue
  Tipo: Int32

Valor de retorno

Tipo: EnvDTE.Command
Um objeto Command.

Comentários

Os suplementos depois poderão alterar o nome de ButtonText respondendo ao método de QueryStatus . Se o texto começa com “#”, o resto da cadeia de caracteres é um inteiro que representa uma ID de recurso na DLL satélite registrado Adicionar - in's.

O parâmetro de ContextUIGUIDs e o parâmetro de vsCommandStatusValue são usados quando o suplemento não é carregado e assim não pode responder ao método de QueryStatus . Se ContextUIGUIDs estiver vazia, o comando está habilitado até que o suplemento é carregado e pode responder a QueryStatus.

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

Exemplos

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddControlExample()
   ' 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 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.
   cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj.AddControl(cmdbarobj)
   cmds.AddNamedCommand(colAddins.Item(1), "MyCommand", _
   "Button Text", "Some tooltip", 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