Método Commands2.AddNamedCommand2

Artigo
05/17/2015

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 AddNamedCommand2 ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Object, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandStatusValue As Integer, _
    CommandStyleFlags As Integer, _
    ControlType As vsCommandControlType _
) As Command

Command AddNamedCommand2(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    Object Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandStatusValue,
    int CommandStyleFlags,
    vsCommandControlType ControlType
)

Command^ AddNamedCommand2(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] Object^ Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandStatusValue, 
    [InAttribute] int CommandStyleFlags, 
    [InAttribute] vsCommandControlType ControlType
)

abstract AddNamedCommand2 : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:Object * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandStatusValue:int * 
        CommandStyleFlags:int * 
        ControlType:vsCommandControlType -> Command

function AddNamedCommand2(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : Object, 
    ContextUIGUIDs : Object[], 
    vsCommandStatusValue : int, 
    CommandStyleFlags : int, 
    ControlType : vsCommandControlType
) : Command

Parâmetros

AddInInstance
Tipo: AddIn

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

Name
Tipo: String

Obrigatório. A forma curta de nome para o novo comando. oAddNamedCommand2 usa o prefácio Addins.Progid. para criar um nome exclusivo.

ButtonText
Tipo: String

Obrigatório. O nome para mostrar na interface do usuário para este comando.

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. Deve ser false.

Bitmap
Tipo: Object

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

Bitmap pode ser um dos seguintes:

- Bitmap

- Icon

- Um IPicture

- A identificação de um recurso de bitmap 16x16 (mas não de um recurso de ícone) que é fornecido pelo suplemento. O Visual Studio tem primeiro no DLL de satélite suplemento. Se o recurso não for encontrado lá, o DLL do suplemento será pesquisada.

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 para o comando.

vsCommandStatusValue
Tipo: Int32

Opcional. Determina se o estado desativado de comando é invisível ou desativado quando você fornecer um parâmetro de ContextUIGUIDs e nenhum são atualmente ativo. Consulte vsCommandDisabledFlags.

CommandStyleFlags
Tipo: Int32

Opcional. Um dos sinalizadores, em particular de vsCommandStylePict, de vsCommandStylePictAndText, ou de vsCommandStyleTextde vsCommandStyle .

ControlType
Tipo: EnvDTE80.vsCommandControlType

Opcional. Define o tipo de controle adicionado quando interface do usuário é criado.

Valor de retorno

Tipo: Command
O comando chamado que foi criado.

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.

Há dois estados de comando padrões: o estado padrão ativado e o estado padrão de visibilidade. Esses estados padrão são importantes se um manipulador de comando não pode ser encontrado (porque o componente não está carregado ou não implementa IDTCommandTarget). Se o componente é carregado e implementa IDTCommandTarget, os valores padrão nunca se aplicam.

Há dois casos interessantes onde os estados padrão são usados:

Você fornece o contexto GUIDs de interface do usuário através de parâmetro de ContextUIGUIDs . A visibilidade é determinada nesse caso totalmente pelo contexto fornecido GUIDS. Se o contexto é ativa, então o comando é visível, se não está oculto. O estado ativado totalmente é determinado pelos valores padrão. No Visual Studio um comando é ativado por padrão sempre se você passar o vsCommandDisabledFlagsGrey seu estado padrão será desativado em seguida. Se você passar vsCommandDisabledFlagsEnabled, ou você simplesmente não fornece esse parâmetro, então o estado padrão está habilitado.
Você não fornece o contexto GUIDs de interface do usuário através de parâmetro de ContextUIGUIDs . A visibilidade é baseada nesse caso nos sinalizadores que você passa para vsCommandStatusValue ou o estado padrão. A visibilidade padrão de comando dentro CONTRA ser é visível. Se você passar vsCommandDisabledFlagsHidden aqui, o padrão é invisível. O estado ativado é o mesmo aqui como é o caso de 1 acima (determinado pelos sinalizadores e/ou por padrão CONTRA o comportamento).

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 .

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

Compartilhar via