Compartilhar via

inscrição do suplemento

  • Artigo

Depois que um suplemento é criado, você deve registrá-lo com Visual Studio antes de se tornar disponível para ativação no Gerenciador de suplementos. Isso foi concluído em versões anteriores do Visual Studio usando as chaves do registro, mas agora é realizada usando um arquivo XML.

Observação:

O arquivo .Addin é criado automaticamente quando você criar um suplemento usando o Assistente de suplemento.As seguintes informações se aplicam somente se você deseja criar ou edição manualmente do inscrição de arquivo de suplemento.

No Visual Studio .NET 2002 e Visual Studio .NET 2003, era necessário registrar o suplemento assemblies com o Windows sistema autônomo componentes COM usando a ferramenta de inscrição do assembly (regasm.exe).Além disso, era necessário registrar o suplemento com Visual Studio usando as chaves no registro do Windows antes do suplemento apareceria na Gerenciador de suplemento.

Essas etapas tiverem sido alterados, começando com Visual Studio 2005. Você não precisará mais registrar assemblies .NET com o Windows usando regasm.Em vez disso, você simplesmente coloque o assembly DLL arquivo em um diretório específico (descrito posteriormente neste tópico) juntamente com um arquivo XML que tem uma extensão de arquivo .Addin.Este arquivo XML descreve as informações que Visual Studio requer a exibir a add-no Gerenciador de suplementos. Quando Visual Studio é iniciado, ele procura no local do arquivo (abaixo) para todos os arquivos disponível .Addin .Addin. Se ele encontrar algum, ele lê o arquivo XML e fornece o Gerenciador de suplemento com as informações necessárias para iniciar o add-in quando é clicado.

Esse método de inscrição simplificado permite que instalações estilo XCopy para suplementos de código gerenciado.Se você colocar todos os arquivos no local certo, então seu suplemento funciona muito bem.Além disso, o uso de comentários XML para definir as configurações de inscrição de suplementos permite que as informações a serem mais com com facilidade compreendido e que chaves do inscrição editado.

O arquivo .Addin

Um novo arquivo XML com a extensão, .Addin, as configurações de Registro substitui o suplemento antigo.Duas cópias do arquivo .Addin são criadas automaticamente após a conclusão do Assistente de suplemento:

.Addin local do arquivo

Local do arquivo .dll

Descrição

Pasta do suplemento

(por exemplo, \Documents and Settings\All Users\Shared Documentos\Visual Studio 2008\Addins)

- ou -

\Documents and Settings\ nome de usuário > \Meus Documentos\Visual studio 2008\Addins)

Pasta de depurar do projeto

\Meus (por exemplo, Meus Documentos\Visual Studio Projects\MyAddin1\MyAddin1\bin)

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

Pasta do projeto raiz

(por exemplo, \Meus Documentos\Visual Studio\Projects\MyAddin1)

Caminho local (MyAddin1.dll)

Usado para a implantação do projeto suplemento.Ele está incluído no projeto para facilitar a edição e é conjunto até o caminho local para a implantação do XCopy estilo.

O arquivo XML de .Addin é dividido em seções com marcas de formatação a seguir:

Configuração

Descrição

Aplicativo do host

(Obrigatório). Especifica os nomes e números de versão dos aplicativos que podem carregar o suplemento.

Assembly

(Obrigatório). Especifica o local dos binários suplemento.Este campo pode ser definido para um caminho local, um caminho de rede ou uma URL válida.

Nome completo da classe

(Obrigatório). Especifica o nome da classe usada para conectar o suplemento.

Comportamento de carregamento

(Opcional) Define se um suplemento a foi carregado na inicialização ou manualmente.

Pré-carregamento de comando

(Opcional) Especifica pré-carregado estado do suplemento, ou seja, se o suplemento deve criar sua interface do usuário (UI) usando um método, sistema autônomo ou nãoCommands.AddNamedCommand.

Segurança de linha de comando

(Opcional) Especifica o Visual Studio modos com sistema autônomo quais o suplemento é compatível, sistema autônomo linha de comando única, integrada de ambiente de desenvolvimento (IDE somente), ou ambos.

A seguir estão os detalhes de cada configuração.

Aplicativo do host

<Name> marca contém o nome do aplicativo. Este é o nome exibido na BAR de título do aplicativo ou retornados pela DTE.Name. Assim, por exemplo, para Visual Studio, a marca conteria "Microsoft Visual Studio", e para o IDE de macros, a marca conteria "Macros do Microsoft Visual Studio."

Pode haver mais de um valor de aplicativos de host por arquivo .Addin.Cada valor deve ser bracketed pelo <Name> marca dentro do <HostApplication> marca. Juntamente com o <Name> marcar cada <HostApplication> marca também deve incluir o número de versão do aplicativo bracketed por <Version> Rótulos de formatação. Por exemplo:

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

Como alternativa, você pode especificar um asterisco para representar o valor de <Version> para qualquer versão do Visual Studio. Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessas Rótulos.

Nome amigável

The <FriendlyName> marca, localizada sob a <Addin> marca, especifica a seqüência de caracteres que será exibido na Add-ins disponível coluna para o suplemento no Gerenciador de suplemento.A seguir é um exemplo de seu uso:

   <FriendlyName>My New Super Addin</FriendlyName>

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Descrição

The <Description> marca, localizada sob a <Addin> marca, especifica a seqüência de caracteres que será exibido na Descrição caixa para o suplemento no Gerenciador de suplemento.A seguir é um exemplo de seu uso:

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

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Sobre detalhes de caixa

Se você selecionar a opção de gerar configurações para o Ajuda sobre caixa de diálogo quando você cria seu suplemento, essa marca é adicionada ao arquivo .Addin.This tag specifies the text that will display for your add-in in the Visual Studio Help About dialog box.A seguir é um exemplo de seu uso:

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

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Sobre dados de ícone

Se você selecionar a opção de gerar configurações para o Ajuda sobre caixa de diálogo quando você cria seu suplemento, essa marca é adicionada ao arquivo .Addin.This tag contains binary data that specifies the icon that will display for your add-in in the Visual Studio Help About dialog box.A seguir é um exemplo de seu uso:

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

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Assembly

The <Assembly> marca, localizada sob a <Addin> marca, especifica o local do suplemento arquivos binário. Essa marca pode ser conjunto para um caminho local, um caminho de rede ("arquivo"), um nome de assembly registrados ("assembly") ou uma URL válida ("url").Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

  • Veja a seguir um exemplo de um local de suplemento do URL.Nesse caso, a src o parâmetro é conjunto para url para indicar o local com base na Web da DLL do suplemento:

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

  • Veja a seguir um exemplo de um local de caminho local.Nesse caso, a src o parâmetro é conjunto para file para indicar o local de local da DLL do suplemento:

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

  • Veja a seguir um exemplo de um caminho local.Nesse caso, a src o parâmetro é conjunto para assembly para indicar o local com base na Web da DLL do suplemento:

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

Nome completo da classe

The <FullClassName> marca Especifica o nome completo da classe usada para se conectar ao suplemento, incluindo o namespace que contém a classe. A seguir está um uso de exemplo:

    <FullClassName>MyAddin4.Connect</FullClassName>

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Comportamento de carregamento

The <LoadBehavior> marca define se um suplemento seja carregado automaticamente na inicialização do IDE ou se ele é iniciado manualmente. The <LoadBehavior> marca está sob o <Addin> marca. A seguir está um uso de exemplo:

    <LoadBehavior>1</LoadBehavior>

Enquanto o uso do <LoadBehavior> marca é opcional, é recomendável que você use para definir explicitamente quando um suplemento é carregado.

Valor

Descrição

0

O suplemento 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 a partir da linha de comando com uma comutador de compilação (devenv /build).

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Pré-carregamento de comando

The <CommandPreload> marca Especifica pré-se ou não o suplemento deve ser carregado. Pré-carregamento carrega a adicionar a primeira time que Visual Studio é iniciado depois de colocar o arquivo .Addin no disco. A seguir está um uso de exemplo:

    <CommandPreload>1</CommandPreload>

Esta marca permite que você especifique que um suplemento deve ser carregado depois Visual Studio é iniciado. Ele dá seu suplemento uma chance de criar elementos de interface, tais sistema autônomo botões da BAR de comandos, de usuário necessários ou executar outras tarefas de inicialização apenas para a time do primeiro, sistema autônomo a criação de padrão sistema autônomo configurações de adicionar.O suplemento é então imediatamente descarregado até que um usuário executa um dos comandos do suplemento criado, que carrega o suplemento conforme necessário em todas sistema autônomo instâncias sucessivas do IDE.

Valor

Descrição

0

O suplemento não será carregado até que seja o usuário inicia-lo por meio do Gerenciador de suplementos ou até que o suplemento é defina para carregar na inicialização.

1

O suplemento é carregado automaticamente quando Visual Studio é iniciado pela primeira vez depois que o arquivo XML de .Addin é colocado no disco.

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

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Segurança de linha de comando

O opcional<CommandLineSafe> marca de formatação indica se o suplemento foi projetado para evitar a exibição de uma interface do usuário quando iniciado por linha de comando devenv, sistema autônomo quando executar linha de comando cria ou operações semelhantes. (Isso é concluído por escolher o O suplemento nunca colocará uma interface modal opção de a Assistente de suplemento.) Além disso, ele especifica o Visual Studio modos com sistema autônomo quais o suplemento é compatível, sistema autônomo apenas a linha de comando ou apenas IDE. A seguir está um uso de 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.

Consulte a seção exemplo .Addin arquivo XML, neste tópico local hierárquica dessa marca.

Exemplo .Addin XML arquivo

A seguir é um exemplo de arquivo XML .Addin completa.Ela mostra a hierarquia e locais para as Rótulos mencionadas anteriormente.

<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<Extensibility 
  xmlns="https://schemas.microsoft.com/AutomationExtensibility">
    <HostApplication>
        <Name>Microsoft Visual Studio Macros</Name>
        <Version>9.0</Version>
    </HostApplication> 
    <HostApplication>
        <Name>Microsoft Visual Studio</Name>
        <Version>9.0</Version>
    </HostApplication>
    <Addin>
        <FriendlyName>My great new add-in.</FriendlyName>
        <Description>This add-in does it all.</Description>
        <AboutBoxDetails>Copyright 2008.</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 com o Gerenciador de suplemento

Como: Criar um suplemento

Demonstra Passo a passo: Criando um assistente

Conceitos

Gráfico do modelo de objetos de automação

Referência

O Visual Studio comandos e opções

Outros recursos

Criando suplementos e assistentes