Registro do suplemento

Depois de um suplemento é criado, você deve registrar com o Visual Studio antes que ele poderá ser ativado em Gerenciador de suplementos.Isso é realizado usando um arquivo XML que tenha nome de arquivo.

O arquivo. AddIn descreve as informações que Visual Studio requer para exibir o suplemento em Gerenciador de suplementos.Quando Visual Studio é iniciado, ele examina o local do arquivo. AddIn para quaisquer arquivos. AddIn disponíveis.Se encontrar algum, ela lê o arquivo XML e retorna Gerenciador de suplementos a informação necessária para iniciar o suplemento quando ele for clicado.

O arquivo. AddIn é criado automaticamente quando você criar um suplemento usando o Assistente de suplemento.Você também pode criar um arquivo. AddIn manualmente usando as informações neste tópico.

Locais de Arquivos

Duas cópias do arquivo. AddIn são criadas automaticamente pelo Assistente do suplemento, da seguinte maneira:

Para instalar o suplemento em outro computador, o arquivo. AddIn deve ser colocado em um local onde Visual Studio verifica para suplementos.Nesses locais estão listados na Opções caixa de diálogo, na ambiente nó diante do Add-in de segurança página. Para mais informações, consulte Suplemento de segurança.

O arquivo. dll que contém o suplemento pode ser instalado em qualquer lugar no computador cliente.No entanto, recomendamos que você colocá-lo com o arquivo. AddIn.

Observação
O <Assembly> elemento do arquivo. AddIn deve apontar para o arquivo. dll que contém os binários do suplemento.

A.Arquivo de suplemento

O arquivo XML . AddIn é dividido nas seguintes seções com marcas de formatação:

Os seguintes elementos são filhos da <Addin> seção:

Aqui estão os detalhes para cada configuração.Para obter mais informações sobre a localização hierárquica, muitos dos elementos que são descritos, consulte "exemplo.Arquivo XML de addin"neste tópico.

Aplicativo host

O <Name> elemento a Host Application seção contém o nome do aplicativo.Este é o nome que é exibido na barra de título do aplicativo ou é retornado por DTE.Name.Por exemplo, para Visual Studio, a marca conteria "Microsoft Visual Studio" e as macros IDE, a marca conteria "Macros de Visual Studio da Microsoft".

Pode haver mais de um valor de aplicativo Host por arquivo. AddIn.Cada valor deve ser bracketed por meio de <Name> marcas a <HostApplication> elemento.Para além de que contém um <Name> elemento, cada <HostApplication> elemento também deve incluir o número da versão do aplicativo bracketed por <Version> marcas.Por exemplo,

   <HostApplication>
      <!-- First Host App name (required). -->
      <Name>Microsoft Visual Studio</Name>
      <Version>10.0</Version>
   </HostApplication>
   <HostApplication>
      <!-- An additional supported program/version. -->
      <Name>Microsoft Visual Studio Macros</Name>
      <Version>10.0</Version>
   </HostApplication>

Como alternativa, você pode especificar um asterisco (*) para representar o valor para <Version> para qualquer versão do Visual Studio.

Nome amigável

O <FriendlyName> elemento, que se encontra na <Addin> elemento, especifica a seqüência que será exibida na suplementos disponíveis coluna na Gerenciador de suplementos.Por exemplo,

   <FriendlyName>My New Super Addin</FriendlyName>

Descrição

O <Description> elemento, que se encontra na <Addin> elemento, especifica a seqüência que será exibida na Descrição caixa no Gerenciador de suplementos.Por exemplo,

   <Description>This add-in will change your life!</Description>

Sobre detalhes de caixa

Se você selecionar a opção de gerar configurações para o sobrecaixa de diálogo quando você criar seu suplemento, esse elemento é adicionado para o arquivo. AddIn. Este elemento Especifica o texto que será exibido na Visual Studiosobrecaixa de diálogo.  Por exemplo,

   <AboutBoxDetails>For add-in support, call 1-800-xxx-
     xxxx.</AboutBoxDetails>

Sobre os dados de ícone

Se você selecionar a opção de gerar configurações para o sobrecaixa de diálogo quando você criar seu suplemento, esse elemento é adicionado para o arquivo. AddIn. Esse elemento contém dados binário que especifica o ícone que será exibido na Visual Studiosobrecaixa de diálogo.  Por exemplo,

<AboutIconData>0000010006 . . . FFFF0000</AboutIconData>

Assembly

O <Assembly> elemento, que se encontra na <Addin> elemento, especifica o local dos arquivosbinário suplemento. Esse elemento pode ser definido como um caminho relativo, um caminho absoluto ("file"), um nome de assembly de registrado ("assembly") ou uma URL ("url").

• O exemplo a seguir mostra um local de caminho absoluto.Neste maiúsculas e minúsculas, o src parâmetro for definido como file para indicar o local do suplemento DLL.

  <Assembly src="file">C:\Documents and Settings\jdoe\Application Data\Microsoft\Visual Studio\10.0\AddIns\MyAddin4.dll</Assembly>
  

• O exemplo a seguir mostra um local registrado.Neste maiúsculas e minúsculas, o src parâmetro for definido como assembly para indicar um registrado suplemento DLL.

  <Assembly src="assembly">BookshelfDefineAddin</Assembly>
  

• O exemplo a seguir mostra um local de URL .Neste maiúsculas e minúsculas, o src parâmetro for definido como url para indicar a Web-com base no local do suplemento DLL.

  <Assembly src="url">http://somewebsite.com/MyAddin4.dll</Assembly>
  

Nome completo da classe

O <FullClassName> elemento Especifica o nome completo da classe que é usado para conectar ao suplemento.Isso inclui o namespace que contém a classe.Por exemplo,

    <FullClassName>MyAddin4.Connect</FullClassName>

Comportamento de carregamento

O <LoadBehavior> elemento define se um suplemento é carregado automaticamente na inicialização do IDE ou for iniciado manualmente.O <LoadBehavior> elemento está sob o <Addin> elemento.Por exemplo,

    <LoadBehavior>1</LoadBehavior>

Embora o uso de <LoadBehavior> é opcional, recomendamos que você use para definir explicitamente quando um suplemento é carregado.

Comando Preload

O <CommandPreload> elemento Especifica se o suplemento deve ser pré-carregados.Pré-carregamento carrega o suplemento na primeira vez em que Visual Studio for iniciado após o arquivo. AddIn está instalado.Por exemplo,

    <CommandPreload>1</CommandPreload>

Esse elemento permite que você especificar que um suplemento deve ser carregado depois Visual Studio é iniciado.Ele dá uma chance de seu suplemento para criar necessários elementos de interface do usuário, como botões da barra de comando ou executar outras tarefas de inicialização de somente para a hora do primeiro como criação de suplemento configurações padrão.O suplemento é então descarregado até que um usuário executa um dos comandos que o suplemento criado.Daí em diante, o suplemento é carregado conforme necessário.

Você pode verificar a OnConnection método que você pode implementar para ver se o tipo de conexão, que é especificado usando o segundo argumento para OnConnection, é ext_cm_UISetup. Se for, você pode executar qualquer colocações de comando desejado, usando o AddNamedCommand ou AddControl método.

Segurança de linha de comando

Opcional <CommandLineSafe> elemento indica se o suplemento foi projetado para evitar a exibição de uma interface do usuário quando ele é iniciado em um prompt de comando, por exemplo, quando você executa o comando – compilações delinha ou operações semelhantes.(Isso é feito selecionando Meu suplemento nunca colocará uma interface modal na Assistente Add-in.) Além disso, ele especifica o Visual Studio modos com que o suplemento é compatível, por exemplo, alinhacomando --somente ou apenas IDE.Por exemplo,

    <CommandLineSafe>0</CommandLineSafe>

Página de opções de ferramentas

Opcional <ToolsOptionsPage> elemento Especifica um Opções de página para que os usuários podem configurar o suplemento.Nós filho especificam a categoria e subcategoria que a página é exibida e o nome do assembly e o nome completo da classe da Opções página.O exemplo a seguir mostra a hierarquia desse elemento:

  <ToolsOptionsPage>
    <Category Name="Text Editor">
      <SubCategory Name="General">
        <Assembly>"MyFilePath\MyAddInOptionPage.dll"</Assembly>
        <FullClassName>"MyNamespace.MyAddInOptionPage"</FullClassName>
      </SubCategory>
    </Category>
  </ToolsOptionsPage>

Exemplo.Arquivo XML de AddIn

O exemplo a seguir mostra um arquivo XML . AddIn completa.Ela mostra a hierarquia e locais para os elementos que estão descritos neste tópico.

<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<Extensibility 
  xmlns="https://schemas.microsoft.com/AutomationExtensibility">
    <HostApplication>
        <Name>Microsoft Visual Studio Macros</Name>
        <Version>10.0</Version>
    </HostApplication> 
    <HostApplication>
        <Name>Microsoft Visual Studio</Name>
        <Version>10.0</Version>
    </HostApplication>
    <Addin>
        <FriendlyName>My great new add-in.</FriendlyName>
        <Description>This add-in does it all.</Description>
        <AboutBoxDetails>Copyright 2010.</AboutBoxDetails>
        <AboutIconData>0000 . . . FFFF0000</AboutIconData>
        <Assembly>MyNewAddin.dll</Assembly>
        <FullClassName>MyNewAddin.Connect</FullClassName>
        <LoadBehavior>1</LoadBehavior>
        <CommandPreload>1</CommandPreload>
        <CommandLineSafe>0</CommandLineSafe>
    </Addin>
</Extensibility>

Consulte também

Tarefas

Como: Add-Ins de controle, usando o Gerenciador de suplemento

Como: criar um suplemento

Passo a passo: Criando um assistente

Referência

Switches e comandos de Visual Studio

Conceitos

Gráfico de modelo de objeto de automação

Outros recursos

A criação de suplementos e assistentes