Partilhar via

Método Commands2.AddNamedCommand (AddIn, String, String, String, Boolean, Int32, array<Object %, Int32)

  • 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 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
    Obrigatório.O AddIn objeto está adicionando o novo comando.
  • Name
    Tipo: System.String
    Obrigatório.A forma abreviada do nome do novo comando.AddNamedCommandprefaces isso com "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 se a imagem de botão de comando nomeado é uma imagem do Office.True= botão.Se MSOButton é False, em seguida, Bitmap é a identificação de um recurso de bitmap de 16 x 16 (mas não é um recurso de ícone) em um Visual C++ DLL de recurso que deve residir em uma pasta com o identificador de localidade do idioma (1033 para inglês). 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.
  • Bitmap
    Tipo: System.Int32
    Opcional.A identificação de um bitmap para exibir no botão.
  • 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.

Valor de retorno

Tipo: EnvDTE.Command
A Command objeto.

Implementações

Commands.AddNamedCommand(AddIn, String, String, String, Boolean, Int32, array<Object[]%, Int32)

Comentários

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.

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

Consulte também

Referência

Commands2 Interface

Sobrecargas AddNamedCommand

Namespace EnvDTE80