Adicionar-No registro

Artigo
08/04/2011

Depois de um suplemento é criado, você deve registrá-lo com Visual Studio antes que ele poderá ser ativado em Gerenciador de suplementos. Isso é realizado usando um arquivo XML que tem uma extensão de nome de arquivo. addin.

O arquivo. addin descreve as informações que Visual Studio requer para exibir o suplemento no Gerenciador de suplementos. Quando Visual Studio é iniciado, ele procura no local do arquivo. addin para quaisquer arquivos AddIn disponíveis. Se encontrar algum, ele lê o arquivo XML e oferece Gerenciador de suplementos as informações que ele necessita para iniciar o add-in quando é clicado.

O arquivo. addin é criado automaticamente quando você cria um add-in 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 Add-In, da seguinte maneira:

.Local do arquivo de suplemento	.Local do arquivo dll	Descrição
Pasta raiz do projeto \Documentos\Visual Studio 2010\Projects\MyAddin1\MyAddin1\	Caminho local (MyAddin1.dll)	Usado para a implantação de projeto de suplemento. Incluído no projeto para facilitar a edição e tem o caminho local para a implantação do XCopy estilo.
Pasta do suplemento \Documentos\Visual Studio 2010\Addins\ - ou - Compartilhado local documentos\Addins\	Pasta de depuração do projeto (Por exemplo, \ Documentos\Visual Studio 2010 Projects\MyAddin1\MyAddin1\bin\)	Usada para executar o suplemento no ambiente de depuração. Sempre deve apontar para o caminho de saída da configuração de compilação atual.

Pasta raiz do projeto

\Documentos\Visual Studio 2010\Projects\MyAddin1\MyAddin1\

Caminho local (MyAddin1.dll)

Usado para a implantação de projeto de suplemento. Incluído no projeto para facilitar a edição e tem o caminho local para a implantação do XCopy estilo.

Pasta do suplemento

\Documentos\Visual Studio 2010\Addins\

- ou -

Compartilhado local documentos\Addins\

Pasta de depuração do projeto

(Por exemplo, \ Documentos\Visual Studio 2010

Projects\MyAddin1\MyAddin1\bin\)

Usada para executar o suplemento no ambiente de depuração. Sempre deve apontar para o caminho de saída da configuração de compilação atual.

Para instalar o suplemento em outro computador, o arquivo. addin deve ser colocado em um local onde o Visual Studio de procura de add-ins. Nesses locais estão listados na Opções na caixa a ambiente nó diante do Macros/adicionar segurança página. Para obter mais informações, consulte Adicionar-no/macros de segurança, Ambiente, Opções Caixa de Diálogo e Adicionar-Na 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 add-in.

A.Arquivo de suplemento

O arquivo XML. addin é dividido nas seguintes seções marcadas:

Section	Descrição
Aplicativo de host	(Obrigatório). Especifica os nomes e números de versão dos aplicativos que podem carregar o suplemento.
AddIn	(Obrigatório) Contém os elementos que descrevem o add-in.
Página de opções de ferramentas	(Opcional) Especifica uma página da Opções caixa de diálogo onde o add-in pode ser configurado. Nós filho especificam a categoria e subcategoria da Opções página e também seu nome de assembly e o nome completo da classe.

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

Elemento	Descrição
Sobre os detalhes de caixa	(Opcional) Especifica o texto que será exibido para o add-in na Visual Studio sobre caixa de diálogo.
Sobre os dados de ícone	(Opcional) Contém dados binários que especifica o ícone que será exibido para o add-in na Visual Studio sobre caixa de diálogo.
Sobre a localização do ícone	(Opcional) Especifica o caminho absoluto ou relativo do ícone que será exibido para o add-in na Visual Studio sobre caixa de diálogo.
Assembly	(Obrigatório). Especifica o local dos binários do suplemento. Este campo pode ser definido para uma URL, um caminho de rede ou um caminho local.
Segurança de linha de comando	(Opcional) Especifica o Visual Studio modos com que o suplemento é compatível, por exemplo, ambiente de desenvolvimento de única e integrada de linha de comando (IDE)-apenas, ou ambos.
Pré-carregamento de comando	(Opcional) Especifica o estado pré-carregado do suplemento; ou seja, se o suplemento deve criar sua interface do usuário usando um método, como Commands.AddNamedCommand.
Nome completo da classe	(Obrigatório). Especifica o nome da classe que é usado para conectar o suplemento.
Comportamento de carregamento	(Opcional) Define se um suplemento a é carregado na inicialização ou manualmente.

Aqui estão os detalhes de 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 de 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 para o IDE de Macros, a marca conteria "Microsoft Visual Studio Macros".

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 contendo um <Name> elemento, cada <HostApplication> elemento também deve incluir o número de 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 está localizado na <Addin> elemento, especifica a seqüência de caracteres será exibida na suplementos disponíveis coluna em Gerenciador de suplementos. Por exemplo,

   <FriendlyName>My New Super Addin</FriendlyName>

Descrição

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

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

Sobre os detalhes de caixa

Se você selecionar a opção de gerar configurações para o sobre caixa de diálogo quando você cria seu suplemento, esse elemento é adicionado ao arquivo. addin. Este elemento Especifica o texto que será exibido na Visual Studio sobre caixa 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 sobre caixa de diálogo quando você cria seu suplemento, esse elemento é adicionado ao arquivo. addin. Esse elemento contém dados binários que especifica o ícone que será exibido na Visual Studio sobre caixa de diálogo. Por exemplo,

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

Assembly

O <Assembly> elemento, que se encontra sob o <Addin> elemento, especifica o local do suplemento binário arquivos. Esse elemento pode ser definido como um caminho relativo, um caminho absoluto ("file"), um nome de assembly registrados ("montagem") ou uma URL ("url").

O exemplo a seguir mostra o local de caminho absoluto. Nesse caso, 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. Nesse caso, o src parâmetro for definido como assembly para indicar um registrado suplemento DLL.
```
<Assembly src="assembly">BookshelfDefineAddin</Assembly>
```
O exemplo a seguir mostra o local do URL. Nesse caso, o src parâmetro for definido como url para indicar o local baseado na Web 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 é usada para se conectar a add-in. 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ê usá-lo para definir explicitamente quando um suplemento é carregado.

Valor	Descrição
0	O add-in não está carregado na inicialização do IDE e deve ser iniciado manualmente.
1	O suplemento é carregado automaticamente na inicialização do IDE.
4	O suplemento é carregado quando devenv é iniciado em um prompt de comando, usando a opção de compilação (devenv /build).

Pré-carregamento de comando

O <CommandPreload> elemento Especifica se o suplemento deve ser pré-carregados. Cargas de pré-carregamento do suplemento na primeira vez em que Visual Studio é iniciado após a instalação do arquivo. addin. Por exemplo,

    <CommandPreload>1</CommandPreload>

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

Valor	Descrição
0	O suplemento não carregar até que o usuário inicia-lo usando o Gerenciador de suplementos ou o suplemento seja definido para carregar na inicialização.
1	O suplemento é carregado automaticamente quando Visual Studio é iniciado pela primeira vez após a instalação do arquivo. addin.

Você pode verificar a OnConnection método 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 posicionamentos do 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 a linha de comando cria ou operações semelhantes. (Isso é feito selecionando Meu suplemento nunca colocará uma interface modal no o Assistente de suplemento.) Além disso, ele especifica o Visual Studio com que o suplemento é compatível, por exemplo, o comando apenas de linha ou de IDE apenas modos. Por exemplo,

    <CommandLineSafe>0</CommandLineSafe>

Valor	Descrição
0	Especifica que o suplemento não é segura para a linha de comando e pode exibir uma interface do usuário.
1	Especifica que o suplemento é segura para a linha de comando e não exibe uma interface do usuário.

Página de opções de ferramentas

Opcional <ToolsOptionsPage> elemento Especifica um Opções para que os usuários podem configurar o add-in de página. 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 de 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

Compartilhar via