Rejestracja dodatków

Artykuł
06/10/2015

Dodatki programu Visual Studio nie są już obsługiwane w programie Visual Studio 2013.Należy wykonać uaktualnienie dodatków do rozszerzeń VSPackage.Aby uzyskać więcej informacji dotyczących uaktualniania, zobacz Często zadawane pytania: konwertowanie dodatków na rozszerzenia pakietu VSPackage.

Dodatek utworzeniu, należy zarejestrować się za pomocą Visual Studio w celu aktywowania go w Menedżer dodatków.Można to osiągnąć przy użyciu pliku XML, który ma rozszerzenie nazwy pliku .addin.

Plik .addin informacje o które Visual Studio wymaga, aby wyświetlić dodatku w Menedżer dodatków.Gdy Visual Studio jest uruchamiana, wygląda w lokalizacji pliku .addin wszelkich dostępnych .addin plików.Jeśli znajdzie żadnego odczytuje plik XML i zapewnia Menedżer dodatków informacji wymaga, aby rozpocząć dodatku po kliknięciu.

Plik .addin jest tworzony automatycznie podczas tworzenia dodatek za pomocą Kreatora dodatku.Plik .addin można również utworzyć ręcznie przy użyciu informacji w tym temacie.

Lokalizacje plików

Dwóch kopii pliku .addin są tworzone automatycznie przez kreatora dodatku w następujący sposób:

.Lokalizacja pliku AddIn	.Lokalizacja pliku dll	Opis
Folder projektu głównego \Dokumenty\Visual Studio 2013\Projects\MyAddin1\MyAddin1\	Ścieżka lokalna (MyAddin1.dll)	Używany do użycia we wdrożeniach dodatku projektu.Uwzględnione w projekcie w celu ułatwienia edycji i ma ścieżkę lokalną do użycia we wdrożeniach xcopy stylu.
Folder dodatków \Dokumenty\Visual Studio 2013\Addins\ —lub— Lokalizacja dokumentów udostępnionych\Addins\	Folder debugowania projektu (Na przykład \ Documents\Visual Studio 2013 Projects\MyAddin1\MyAddin1\bin\)	Używane do uruchamiania dodatku w środowisku debugowania.Należy zawsze wskazywać ścieżki wyjściowej bieżącej konfiguracji kompilacji.

Folder projektu głównego

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

Ścieżka lokalna (MyAddin1.dll)

Używany do użycia we wdrożeniach dodatku projektu.Uwzględnione w projekcie w celu ułatwienia edycji i ma ścieżkę lokalną do użycia we wdrożeniach xcopy stylu.

Folder dodatków

\Dokumenty\Visual Studio 2013\Addins\

—lub—

Lokalizacja dokumentów udostępnionych\Addins\

Folder debugowania projektu

(Na przykład \ Documents\Visual Studio 2013

Projects\MyAddin1\MyAddin1\bin\)

Używane do uruchamiania dodatku w środowisku debugowania.Należy zawsze wskazywać ścieżki wyjściowej bieżącej konfiguracji kompilacji.

Aby zainstalować dodatek na innym komputerze, należy umieścić plik .addin w miejscu, w którym program Visual Studio sprawdza, czy dodatki.Te lokalizacje są podane w opcje dialogowym środowiska węzła, na dodatku zabezpieczeń strony.Aby uzyskać więcej informacji, zobacz Zabezpieczenia dodatków.

Plik .dll, który zawiera dodatek można zainstalować dowolne miejsce na komputerze klienckim.Jednak firma Microsoft zaleca, umieść je z plikiem .addin.

[!UWAGA]

<Assembly> Element pliku .addin musi wskazywać plik .dll, który zawiera pliki binarne dla dodatku.

.Dodatek do pliku

Plik XML .addin jest dzielony na następujące sekcje oznakowane:

Sekcja	Opis
Host aplikacji	(Wymagane). Określa nazwy i numery wersji aplikacji, które można załadować dodatku.
Dodatek	(Wymagane) Zawiera elementy, które opisują dodatku.
Narzędzia Opcje strony	(Opcjonalnie) Określa stronę w opcje okno dialogowe, w którym dodatku można skonfigurować.Węzły podrzędne Określ kategorię i Podkategoria opcje strony, a także jego nazwa zestawu i pełną klasy.

Elementy podrzędne są następujące elementy <Addin> sekcji:

Element	Opis
Szczegóły pola — informacje	(Optional) Specifies the text that will be displayed for your add-in in the Visual Studio About dialog box.
Dane ikony — informacje	(Optional) Contains binary data that specifies the icon that will be displayed for your add-in in the Visual Studio About dialog box.
O lokalizacji 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.
Zestaw	(Wymagane). Określa lokalizację plików binarnych dodatku.To pole można podać ścieżkę lokalną, ścieżkę sieciową lub adres URL.
Bezpieczny wiersza polecenia	(Opcjonalnie) Określa Visual Studio tryby, w których dodatek jest zgodny, na przykład wiersza polecenia tylko, zintegrowane środowisko pracy (IDE) — tylko, lub obu tych metod.
Polecenie Wczytaj wstępnie	(Opcjonalnie) Określa wstępnie stan dodatku; oznacza to, czy dodatku należy utworzyć jej interfejsu użytkownika przy użyciu metody, takie jak Commands.AddNamedCommand.
Nazwa klasy Pełna	(Wymagane). Określa nazwę klasy, która jest używana do nawiązania połączenia dodatku.
Zachowanie obciążenia	(Opcjonalnie) Określa, czy dodatek jest ładowany podczas uruchamiania lub ręcznie.

Poniżej znajdują się szczegóły dla każdego ustawienia.Aby uzyskać więcej informacji o lokalizacji hierarchiczne wiele elementów, które są opisane, zobacz "przykład.Plik XML AddIn"dalej w tym temacie.

Host aplikacji

<Name> Elementu w Host Application sekcja zawiera nazwę aplikacji.Jest to nazwa, który jest wyświetlany na pasku tytułu aplikacji lub jest zwracany przez DTE.Name.Na przykład w przypadku Visual Studio, tag będzie zawierać "Programu Microsoft Visual Studio".

Może istnieć więcej niż jedną wartość aplikacji hosta dla pliku .addin.Każda wartość musi być oddzielona przy użyciu <Name> znaczniki w <HostApplication> elementu.Oprócz zawierający <Name> element, co <HostApplication> elementu musi również obejmować numer wersji aplikacji oddzielona przez <Version> tagów.Na przykład

   <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>

Alternatywnie można określić znak gwiazdki (*) reprezentujący wartość dla <Version> dla dowolnej wersji programu Visual Studio.

Przyjazna nazwa

<FriendlyName> Element, który znajduje się w obszarze <Addin> element, określa ciąg, który będzie wyświetlany w dostępne dodatki kolumny w Menedżer dodatków.Na przykład

   <FriendlyName>My New Super Addin</FriendlyName>

Opis

<Description> Element, który znajduje się w obszarze <Addin> element, określa ciąg, który będzie wyświetlany w opis dotyczącym Menedżer dodatków.Na przykład

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

Szczegóły pola — informacje

Jeśli zostanie wybrana opcja do generowania ustawienia dla o okno dialogowe podczas tworzenia dodatku ten element jest dodawany do pliku .addin.This element specifies the text that will be displayed in the Visual Studio About dialog box.Na przykład

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

Dane ikony — informacje

Jeśli zostanie wybrana opcja do generowania ustawienia dla o okno dialogowe podczas tworzenia dodatku ten element jest dodawany do pliku .addin.This element contains binary data that specifies the icon that will be displayed in the Visual Studio About dialog box.Na przykład

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

Zestaw

<Assembly> Element, który znajduje się w obszarze <Addin> elementu, określa lokalizację dodatku pliki binarne.Ten element można skonfigurować, aby ścieżką względną, ścieżką bezwzględną ("plik"), nazwę zestawu zarejestrowanych ("zestawu") lub adres URL ("adres url").

W poniższym przykładzie przedstawiono lokalizacji ścieżki bezwzględne.W takim przypadku src ma ustawioną wartość parametru file wskaż lokalizację pliku DLL dodatku.
```
<Assembly src="file">C:\Documents and Settings\jdoe\Application Data\Microsoft\Visual Studio\12.0\AddIns\MyAddin4.dll</Assembly>
```
W poniższym przykładzie przedstawiono zarejestrowanych lokalizacji.W takim przypadku src ma ustawioną wartość parametru assembly do wskazania zarejestrowanych DLL dodatku.
```
<Assembly src="assembly">BookshelfDefineAddin</Assembly>
```
W poniższym przykładzie pokazano w lokalizacji adresu URL.W takim przypadku src ma ustawioną wartość parametru url wskaż lokalizację pliku DLL dodatku oparte na sieci Web.
```
<Assembly src="url">http://somewebsite.com/MyAddin4.dll</Assembly>
```

Nazwa klasy Pełna

<FullClassName> Element określa pełną nazwę klasy, która jest używana do nawiązania połączenia dodatku.Dotyczy to również obszar nazw, który zawiera klasy.Na przykład

    <FullClassName>MyAddin4.Connect</FullClassName>

Zachowanie obciążenia

<LoadBehavior> Element definiuje, czy dodatek jest ładowany automatycznie przy uruchamianiu IDE lub jest uruchomione ręcznie.<LoadBehavior> Element znajduje się w <Addin> elementu.Na przykład

    <LoadBehavior>1</LoadBehavior>

Chociaż użycie <LoadBehavior> jest opcjonalna, zaleca się używać go do jawnego określania dodatek załadowanie.

Wartość	Opis
0	Dodatek nie jest ładowany podczas uruchamiania środowiska IDE i musi zostać uruchomione ręcznie.
1	Dodatek jest ładowana automatycznie podczas uruchamiania środowiska IDE.
4	Dodatek jest ładowany przy uruchamianiu devenv w wierszu polecenia za pomocą przełącznika kompilacji (devenv /build).

Polecenie Wczytaj wstępnie

<CommandPreload> Element określa, czy dodatek musi być załadowany.Obciążenia wstępnego obciążenia dodatku pierwszym uruchomieniu Visual Studio została uruchomiona po zainstalowaniu pliku .addin.Na przykład

    <CommandPreload>1</CommandPreload>

Ten element umożliwia określenie, czy dodatek muszą zostać załadowane po Visual Studio jest uruchomiona.Umożliwia ona dodatek możliwość tworzenia wymaganych elementów interfejsu użytkownika, takie jak przyciski paska poleceń lub innych zadań inicjowania pierwszej-uwzględniające tylko czas, takich jak tworzenie domyślne ustawienia dodatku.Dodatek jest następnie zwolnione, dopóki użytkownik wykonuje jedno z poleceń, które dodatku utworzone.Dzięki niej kolejne dodatku jest ładowana zgodnie z potrzebami.

Wartość	Opis
0	Dodatku nie załadować dopóki użytkownik uruchamia go za pomocą Menedżer dodatków lub dodatku ma ustawioną wartość obciążenia po ponownym uruchomieniu komputera.
1	Dodatek jest załadowany automatycznie po Visual Studio rozpoczyna się po raz pierwszy po zainstalowaniu pliku .addin.

Można sprawdzić OnConnection metody, która implementuje aby zobaczyć, czy typ połączenia, które jest określana za pomocą drugi argument OnConnection, jest ext_cm_UISetup.Jeśli tak, można wykonać niezależnie od rozmieszczenia polecenie ma za pomocą polecenia AddNamedCommand lub AddControl metody.

Bezpieczny wiersza polecenia

Opcjonalna <CommandLineSafe> elementu wskazuje, czy dodatek został zaprojektowany w celu uniknięcia wyświetlania interfejsu użytkownika po uruchomieniu w wierszu polecenia, na przykład podczas wykonywania wiersza polecenia kompilacje lub podobnych działań.(Jest to wykonywane przez wybranie Moje dodatku nigdy nie spowoduje ustawienie modalne interfejsu użytkownika w dodatku Kreator.) Ponadto określa Visual Studio tryby z którym dodatku jest zgodny, na przykład polecenia-wiersza tylko lub IDE tylko.Na przykład

    <CommandLineSafe>0</CommandLineSafe>

Wartość	Opis
0	Określa, czy dodatku nie jest bezpieczne wiersza polecenia i mogą być wyświetlane interfejsu użytkownika.
1	Określa, czy dodatek jest bezpieczne wiersza polecenia i nie wyświetla interfejsu użytkownika.

Narzędzia Opcje strony

Opcjonalna <ToolsOptionsPage> określa element opcje strony, tak aby użytkownicy mogą skonfigurować dodatku.Węzły podrzędne Określ kategorii i Podkategoria strony będzie widoczna w, i nazwa zestawu i nazwa klasy pełną opcje strony.W poniższym przykładzie pokazano hierarchię tego elementu:

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

Przykład.Dodatek do pliku XML

W poniższym przykładzie pokazano pełną .addin pliku XML.Pokazuje hierarchię i lokalizacje dla elementów, które są opisane w tym temacie.

<?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>

Zobacz też

Udostępnij za pośrednictwem