Método Commands2.AddNamedCommand

Cria um comando chamado que é salvo pelo ambiente e disponibilizado na próxima vez que o ambiente começar, mesmo se o suplemento não está carregado na inicialização de ambiente.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (em EnvDTE80.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: AddIn

  Obrigatório. O objeto de AddIn que está adicionando o novo comando.

• Name
  Tipo: String

  Obrigatório. A forma curta de nome para o novo comando. oAddNamedCommand prefacia este com “Addins.Progid”. para criar um nome exclusivo.

• ButtonText
  Tipo: String

  Obrigatório. O nome a ser usado se o comando for associado a um botão que seja exibido por nome em vez de pelo ícone.

• Tooltip
  Tipo: String

  Obrigatório. O texto exibido quando um usuário passa o ponteiro do mouse sobre qualquer controle associado ao novo comando.

• MSOButton
  Tipo: Boolean

  Obrigatório. Sempre deve ser false.

• Bitmap
  Tipo: Int32

  Opcional. A identificação de um bitmap em exibir no botão.

• ContextUIGUIDs
  Tipo: array<Object[]%

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

• vsCommandDisabledFlagsValue
  Tipo: Int32

  Opcional. Determina o estado de comando quando você fornece ContextUIGUIDs e nenhum dos contextos especificados são atualmente ativo. Este parâmetro deve sempre colocar vsCommandStatusSupported. Se ele também inclui vsCommandStatusEnabled, o comando será ativado.

Valor de retorno

Tipo: Command
Um objeto Command.

Comentários

Suplementos pode posteriormente alterar o nome de ButtonText respondendo ao método de QueryStatus . Se o texto começa com #, então o restante da cadeia de caracteres é um inteiro que representa um ID de recurso satélite registrado no DLL Do suplemento.

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

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

Exemplos

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

Commands2 Interface

Namespace EnvDTE80