Registrace doplňku

Článek
06/10/2015

Doplňky Visual Studio jsou ve verzi sady Visual Studio 2013 zastaralé.Měli byste upgradovat doplňky na rozšíření VSPackage.Další informace o upgradu najdete v tématu Nejčastější dotazy: Převádění doplňků na rozšíření VSPackage.

Po doplněk je vytvořen, je třeba zaregistrovat pomocí tlačítek Visual Studio předtím, než může být aktivováno v Správce doplňků.To lze provést pomocí souboru XML, který má příponu názvu souboru .addin.

Soubor .addin obsahuje informace o který Visual Studio vyžaduje k zobrazení doplněk v Správce doplňků.Při Visual Studio se spustí, hledá v umístění souboru .addin pro všechny soubory .addin k dispozici.Pokud žádný najde, přečte soubor XML a poskytuje Správce doplňků informace vyžaduje ke spuštění doplňku po klepnutí.

Když vytvoříte doplněk pomocí průvodce Add-In je automaticky vytvořen soubor .addin.Můžete také vytvořit soubor s příponou .addin ručně pomocí informací v tomto tématu.

Umístění souborů

Dvě kopie souboru .addin jsou automaticky vytvářeny pomocí průvodce přidat následujícím způsobem:

.Doplněk umístění souboru	.Umístění souboru DLL	Popis
Kořenovou složku projektu \Dokumenty\Visual Studio 2013\Projects\MyAddin1\MyAddin1\	Místní cesta (MyAddin1.dll)	Použít pro nasazení na projekt.Součástí projektu pro snadné úpravy a má místní cestu pro nasazení xcopy stylu.
Přidat do složky \Dokumenty\Visual Studio 2013\Addins\ -nebo- Sdílené dokumenty umístění\Addins\	Ladění složky projektu (Například \ Documents\Visual Studio 2013 Projects\MyAddin1\MyAddin1\bin\)	Slouží ke spouštění doplňku v ladění prostředí.Vždy směřovat výstupní cesta aktuální konfigurace sestavení.

Kořenovou složku projektu

\Dokumenty\Visual Studio 2013\Projects\MyAddin1\MyAddin1\

Místní cesta (MyAddin1.dll)

Použít pro nasazení na projekt.Součástí projektu pro snadné úpravy a má místní cestu pro nasazení xcopy stylu.

Přidat do složky

\Dokumenty\Visual Studio 2013\Addins\

-nebo-

Sdílené dokumenty umístění\Addins\

Ladění složky projektu

(Například \ Documents\Visual Studio 2013

Projects\MyAddin1\MyAddin1\bin\)

Slouží ke spouštění doplňku v ladění prostředí.Vždy směřovat výstupní cesta aktuální konfigurace sestavení.

K instalaci doplňku v jiném počítači, .addin soubor musí být umístěn do umístění, kde sady Visual Studio zkontroluje doplňků.Tato umístění jsou uvedeny v možnosti dialogovém prostředí uzlu, na zabezpečení doplňku stránky.Další informace naleznete v tématu Zabezpečení doplňku.

Soubor DLL, který obsahuje doplněk lze nainstalovat kdekoli v klientském počítači.Doporučujeme však put se souborem .addin.

[!POZNÁMKA]

<Assembly> Element .addin souboru musí odkazovat na soubor DLL, který obsahuje binární soubory pro doplněk.

Je.Doplněk souboru

Soubor XML .addin rozdělen do následujících částí s klíčovými slovy:

Oddíl	Popis
Hostitel aplikace	(Požadováno). Určuje názvy a čísel verzí aplikace, které můžete načíst doplněk.
Doplněk	(Požadováno) Obsahuje prvky, které popisují doplněk.
Stránka Možnosti nástroje	(Volitelné) Určuje, na stránku v možnosti dialogového okna, kde doplňku lze nakonfigurovat.Podřízené uzly zadat kategorie a podkategorie možnosti stránky a také její název sestavení a název úplné třídy.

Následující položky jsou podřízených objektů <Addin> oddílu:

Prvek	Popis
Pole podrobností	(Optional) Specifies the text that will be displayed for your add-in in the Visual Studio About dialog box.
O Data ikony	(Optional) Contains binary data that specifies the icon that will be displayed for your add-in in the Visual Studio About dialog box.
O umístění ikony	(Optional) Specifies the absolute path or relative path of the icon that will be displayed for your add-in in the Visual Studio About dialog box.
Assembly	(Požadováno). Určuje umístění binárních souborů.Toto pole lze nastavit místní cestu, síťovou cestu nebo adresu URL.
Bezpečnost příkazového řádku	(Volitelné) Určuje, Visual Studio režimů, s nimiž doplňku je kompatibilní, například příkazového řádku pouze a integrované vývojové prostředí (IDE) – pouze, nebo obojí.
Příkaz Načíst	(Volitelné) Určuje zaváděnou stav doplňku; To znamená, zda doplňku by měl vytvořit její uživatelského rozhraní pomocí metody Commands.AddNamedCommand.
Název třídy úplná	(Požadováno). Určuje název třídy, která se používá pro připojení k doplňku.
Chování při načítání.	(Volitelné) Určuje, zda doplněk je načten při spuštění nebo ručně.

Zde najdete podrobnosti o každém nastavení.Další informace o umístění, do hierarchické celou řadu elementů, které jsou popsány, naleznete v části "příklad.Soubor XML doplněk"dále v tomto tématu.

Hostitel aplikace

<Name> Element v Host Application oddíl obsahuje název aplikace.Jedná se o název, který se zobrazí v záhlaví aplikace, nebo je vrácen rutinou DTE.Name.Například pro Visual Studio, značka by obsahovala "Sady Microsoft Visual Studio".

Může existovat více než jednu hodnotu hostitelské aplikace na .addin souboru.Každá z jeho hodnot musí být bracketed s použitím <Name> značky v <HostApplication> elementu.Kromě obsahující <Name> elementu, každých <HostApplication> element musí také obsahovat číslo verze aplikace v závorkách podle <Version> klíčová slova.Například

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

Alternativně můžete zadat hvězdičku (*), která představuje hodnotu pro <Version> pro jakoukoliv verzí systému Visual Studio.

Popisný název

<FriendlyName> Element, který se nachází pod <Addin> elementu, určuje řetězec, který se zobrazí v dostupné doplňky sloupec v Správce doplňků.Například

   <FriendlyName>My New Super Addin</FriendlyName>

Popis

<Description> Element, který se nachází pod <Addin> elementu, určuje řetězec, který se zobrazí v popis pole Správce doplňků.Například

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

Pole podrobností

Pokud vyberete možnost k vygenerování nastavení pro o dialogové okno při vytvoření tohoto doplňku tento element je přidán do souboru .addin.This element specifies the text that will be displayed in the Visual Studio About dialog box.Například

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

O Data ikony

Pokud vyberete možnost k vygenerování nastavení pro o dialogové okno při vytvoření tohoto doplňku tento element je přidán do souboru .addin.This element contains binary data that specifies the icon that will be displayed in the Visual Studio About dialog box.Například

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

Assembly

<Assembly> Element, který se nachází pod <Addin> element, určuje umístění doplněk binárních souborů.Tento element lze nastavit relativní cestu, absolutní cestu ("soubor"), název registrované sestavení (dále jen "sestavení") nebo adresu URL (dále jen "adresa url").

Následující příklad ukazuje umístění s absolutní cestu.V takovém případě src parametr je nastaven na file k označení umístění knihovny DLL.
```
<Assembly src="file">C:\Documents and Settings\jdoe\Application Data\Microsoft\Visual Studio\12.0\AddIns\MyAddin4.dll</Assembly>
```
Následující příklad ukazuje registrované umístění.V takovém případě src parametr je nastaven na assembly označíte registrované DLL doplňku.
```
<Assembly src="assembly">BookshelfDefineAddin</Assembly>
```
Následující příklad ukazuje umístění adresy URL.V takovém případě src parametr je nastaven na url k označení umístění založených na webu knihovny DLL.
```
<Assembly src="url">http://somewebsite.com/MyAddin4.dll</Assembly>
```

Název třídy úplná

<FullClassName> Element určuje úplný název třídy, která se používá pro připojení k doplňku.To zahrnuje obor názvů, který obsahuje třídu.Například

    <FullClassName>MyAddin4.Connect</FullClassName>

Chování při načítání.

<LoadBehavior> Element definuje zda doplněk načíst automaticky při spuštění prostředí IDE nebo ručním spuštěním.<LoadBehavior> Element je pod <Addin> elementu.Například

    <LoadBehavior>1</LoadBehavior>

I když použití <LoadBehavior> je volitelné, doporučujeme použít explicitně definovat doplněk načtení.

Hodnota	Popis
0	Doplněk není načten při spuštění prostředí IDE a musí být spuštěna ručně.
1	Doplněk je automaticky načtena při spuštění integrovaného vývojového prostředí.
4	Doplněk je načtena při spuštění devenv na příkazovém řádku pomocí přepínače sestavení (devenv /build).

Příkaz Načíst

<CommandPreload> Element určuje, zda doplňku musí být zavedené.Zatížení předpínacím doplňku první čas, který Visual Studio spuštěna po .addin soubor je nainstalován.Například

    <CommandPreload>1</CommandPreload>

Tento element slouží k určení, že doplněk musí být načtena po Visual Studio je spuštěn.Poskytuje doplněk umožňující vytvářet požadované prvky uživatelského rozhraní, jako je například panelu příkazů nebo provést další úlohy pouze pro první inicializaci, jako je například vytváření výchozí nastavení doplňku.Doplněk je pak odpojeno, dokud uživatel provede jeden z příkazů, které doplňku vytvořeny.Následně doplňku bude načten v případě potřeby.

Hodnota	Popis
0	Doplněk nezavede dokud uživatel ji spustí pomocí Správce doplňků nebo doplňku je nastaven načíst při spuštění.
1	Doplněk je načteny automaticky při Visual Studio spustí poprvé po instalaci v souboru .addin.

Můžete zkontrolovat OnConnection metodu, která implementují zobrazíte zda typ připojení, která je určena pomocí druhým argumentem OnConnection, je ext_cm_UISetup.Je-li, můžete provádět libovolné umístění příkazu se má použít buď AddNamedCommand nebo AddControl metody.

Bezpečnost příkazového řádku

Nepovinný <CommandLineSafe> elementu označuje, zda doplňku byla navržena neuváděli uživatelské rozhraní je spuštěno na příkazovém řádku, například při provádění příkazového řádku sestavení nebo podobné operace.(To lze provést prostřednictvím výběrem Můj doplňku bude nikdy balení modální uživatelského rozhraní v doplňku Průvodce.) Určuje také Visual Studio režimů s který doplněk je kompatibilní, například příkazovém-řádku pouze nebo integrovaného vývojového prostředí pouze.Například

    <CommandLineSafe>0</CommandLineSafe>

Hodnota	Popis
0	Určuje, že doplňku není bezpečné příkazového řádku a mohou být zobrazeny uživatelského rozhraní.
1	Určuje, že doplněk je bezpečný pro příkazový řádek a nezobrazuje uživatelského rozhraní.

Stránka Možnosti nástroje

Nepovinný <ToolsOptionsPage> element určuje možnosti stránky tak, aby uživatelé mohou konfigurovat doplňku.Podřízené uzly zadat kategorie a podkategorie, která stránka se zobrazí v, a název sestavení a název třídy úplná možnosti stránky.Následující příklad ukazuje hierarchii tento element:

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

Příklad.Soubor XML doplněk

Následující příklad ukazuje soubor XML dokončení .addin.Zobrazuje hierarchii a umístění pro elementy, které jsou popsány v tomto tématu.

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

Viz také

Share via