Wpisy rejestru dla dodatków VSTO

  • Artykuł

Podczas wdrażania dodatków VSTO utworzonych przy użyciu programu Visual Studio należy utworzyć określony zestaw wpisów rejestru. Te wpisy rejestru zawierają informacje, które umożliwiają usłudze Microsoft aplikacja pakietu Office lication odnajdywanie i ładowanie dodatku VSTO.

Dotyczy: informacje w tym temacie dotyczą projektów dodatków VSTO. Aby uzyskać więcej informacji, zobacz Funkcje dostępne przez aplikacja pakietu Office lication i typ projektu.

Uwaga

Chcesz opracowywać rozwiązania, które rozszerzają środowisko pakietu Office na wiele platform? Zapoznaj się z nowym modelem dodatków pakietu Office. Dodatki pakietu Office mają niewielki rozmiar w porównaniu z dodatkami I rozwiązaniami VSTO i można je tworzyć przy użyciu niemal dowolnej technologii programowania internetowego, takiej jak HTML5, JavaScript, CSS3 i XML.

Podczas tworzenia projektu program Visual Studio tworzy te wpisy rejestru na komputerze dewelopera. Ułatwia to uruchamianie i debugowanie dodatku VSTO. Za pomocą technologii ClickOnce w celu wdrożenia dodatku VSTO wpisy rejestru są tworzone automatycznie na komputerze użytkownika końcowego.

Aby uzyskać więcej informacji na temat wdrażania rozwiązania VSTO przy użyciu Instalatora Windows, zobacz Wdrażanie rozwiązania VSTO przy użyciu Instalatora Windows.

Aby uzyskać więcej informacji na temat sposobu użycia wpisów rejestru podczas procesu ładowania dodatków VSTO, zobacz Architektura dodatków VSTO.

Uwaga

W tym temacie identyfikator dodatku tekstowego reprezentuje unikatowy identyfikator dodatku VSTO. Domyślnie identyfikator jest nazwą zestawu dodatku VSTO.

Rejestrowanie dodatków VSTO dla bieżącego użytkownika a wszystkich użytkowników

Po zainstalowaniu dodatku VSTO można go zarejestrować na dwa sposoby:

  • Tylko dla bieżącego użytkownika (dodatek VSTO jest dostępny tylko dla użytkownika, który został zalogowany na komputerze po zainstalowaniu dodatku). W tym przypadku wpisy rejestru są tworzone w HKEY_CURRENT_USER.

  • Dla wszystkich użytkowników (czyli każdego użytkownika, który loguje się do komputera, może używać dodatku VSTO). W tym przypadku wpisy rejestru są tworzone w HKEY_LOCAL_MACHINE.

    Wszystkie dodatki VSTO tworzone przy użyciu programu Visual Studio można zarejestrować dla bieżącego użytkownika. Jednak dodatki VSTO można zarejestrować dla wszystkich użytkowników tylko w niektórych scenariuszach. Te scenariusze zależą od wersji pakietu Microsoft Office na komputerze i sposobu wdrażania dodatku VSTO.

Typ wdrożenia

Jeśli używasz technologii ClickOnce do wdrażania dodatku VSTO, dodatek VSTO można zarejestrować tylko dla bieżącego użytkownika. Dzieje się tak, ponieważ technologia ClickOnce obsługuje tylko tworzenie kluczy w HKEY_CURRENT_USER. Jeśli chcesz zarejestrować dodatek VSTO dla wszystkich użytkowników na komputerze, musisz użyć Instalatora Windows, aby wdrożyć dodatek VSTO. Aby uzyskać więcej informacji na temat tych typów wdrożeń, zobacz Wdrażanie rozwiązania pakietu Office przy użyciu technologii ClickOnce i Wdrażanie rozwiązania pakietu Office przy użyciu Instalatora Windows.

Wpisy rejestru

Wymagane wpisy rejestru dodatku VSTO znajdują się w następujących kluczach rejestru, w których katalog główny jest HKEY_CURRENT_USER lub HKEY_LOCAL_MACHINE w zależności od tego, czy instalacja jest dla bieżącego użytkownika lub wszystkich użytkowników.

Aplikacja pakietu Office Ścieżka konfiguracji
Visio Root\Software\Microsoft\Visio\Addins\add-in ID
Wszystkie inne Root\Software\Microsoft\Office\aplikacja pakietu Office lication name\Addins\add-in ID

Uwaga

Jeśli instalator jest przeznaczony dla wszystkich użytkowników w 64-bitowym systemie Windows, zaleca się, aby zawierał dwa wpisy rejestru, jeden w obszarze HKEY_LOCAL_MACHINE\Software\Microsoft i jeden w obszarze HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft hive. Jest to spowodowane tym, że użytkownicy mogą używać 32-bitowych lub 64-bitowych wersji pakietu Office na komputerze.

Jeśli instalator jest przeznaczony dla bieżącego użytkownika, nie musi być instalowany w WOW6432Node, ponieważ ścieżka HKEY_CURRENT_USER\Software jest udostępniona.

Aby uzyskać więcej informacji, zobacz 32-bitowe i 64-bitowe dane aplikacji w rejestrze.

W poniższej tabeli wymieniono wpisy w tym kluczu rejestru.

Wpis Type Wartość
Opis REG_SZ Wymagany. Krótki opis dodatku VSTO.

Ten opis jest wyświetlany, gdy użytkownik wybierze dodatek VSTO w okienku Dodatki okna dialogowego Opcje w aplikacja pakietu Office licacji Microsoft.
Friendlyname REG_SZ Wymagany. Opisowa nazwa dodatku VSTO wyświetlana w oknie dialogowym Dodatki COM w aplikacja pakietu Office lication firmy Microsoft. Wartość domyślna to identyfikator dodatku VSTO.
Loadbehavior REG_DWORD Wymagany. Wartość określająca, kiedy aplikacja próbuje załadować dodatek VSTO i bieżący stan dodatku VSTO (załadowany lub zwolniony).

Domyślnie ten wpis ma wartość 3, która określa, że dodatek VSTO jest ładowany podczas uruchamiania. Aby uzyskać więcej informacji, zobacz LoadBehavior wartości.

Uwaga: jeśli użytkownik wyłączy dodatek VSTO, ta akcja modyfikuje wartość LoadBehavior w gałęzi rejestru HKEY_CURRENT_USER . Dla każdego użytkownika wartość LoadBehavior w HKEY_CURRENT_USER hive zastępuje domyślną wartość LoadBehavior zdefiniowaną w gałęzi HKEY_LOCAL_MACHINE.
Manifestu REG_SZ Wymagany. Pełna ścieżka manifestu wdrożenia dodatku VSTO. Ścieżka może być lokalizacją na komputerze lokalnym, udziale sieciowym (UNC) lub serwerze sieci Web (HTTP).

Jeśli używasz Instalatora Windows do wdrożenia rozwiązania, musisz dodać prefiks file:/// do ścieżki manifestu. Należy również dołączyć ciąg |vstolocal (czyli znak potoku, po którym następuje vstolocal|) na końcu tej ścieżki. Dzięki temu rozwiązanie zostanie załadowane z folderu instalacyjnego, a nie z pamięci podręcznej ClickOnce. Aby uzyskać więcej informacji, zobacz Wdrażanie rozwiązania pakietu Office przy użyciu Instalatora Windows.

Uwaga: podczas tworzenia dodatku VSTO na komputerze dewelopera program Visual Studio automatycznie dołącza ciąg |vstolocal do tego wpisu rejestru.

Wpisy rejestru dla regionów formularzy programu Outlook

Jeśli tworzysz niestandardowy region formularza w dodatku VSTO dla programu Outlook, dodatkowe wpisy rejestru są używane do rejestrowania regionu formularza w programie Outlook. Te wpisy są tworzone w innym kluczu rejestru dla każdej klasy komunikatów obsługiwanej przez region formularza. Te klucze rejestru znajdują się w następującej lokalizacji, w której katalog główny jest HKEY_CURRENT_USER lub HKEY_LOCAL_MACHINE.

Root\Software\Microsoft\Office\Outlook\FormRegions\message, klasa

Podobnie jak inne wpisy rejestru współużytkowane przez wszystkie dodatki VSTO, program Visual Studio tworzy wpisy rejestru regionów formularzy na komputerze deweloperskim podczas tworzenia projektu. Za pomocą technologii ClickOnce w celu wdrożenia dodatku VSTO wpisy rejestru są tworzone automatycznie na komputerze użytkownika końcowego. W przypadku wdrażania dodatku VSTO za pomocą Instalatora Windows należy skonfigurować projekt InstallShield Limited Edition w celu utworzenia wpisów rejestru na komputerze użytkownika końcowego.

Aby uzyskać więcej informacji na temat wpisów rejestru regionów formularzy, zobacz Określanie lokalizacji regionu formularza w formularzu niestandardowym. Aby uzyskać więcej informacji na temat regionów formularzy programu Outlook, zobacz Tworzenie regionów formularzy programu Outlook.

Wartości loadBehavior

Wpis LoadBehavior w obszarze Root\Software\Microsoft\Office\application name\Addins\add-in ID klucza zawiera bitową kombinację wartości, które określają zachowanie czasu wykonywania dodatku VSTO. Najniższy bit kolejności (wartości 0 i 1) wskazuje, czy dodatek VSTO jest obecnie zwolniony, czy załadowany. Inne bity wskazują, kiedy aplikacja próbuje załadować dodatek VSTO.

Zazwyczaj wpis LoadBehavior ma być ustawiony na 0, 3 lub 16 (w dziesiętnym), gdy dodatek VSTO jest zainstalowany na komputerach użytkowników końcowych. Domyślnie program Visual Studio ustawia wpis LoadBehavior dodatku VSTO na wartość 3 podczas kompilowania lub publikowania.

W poniższej tabeli wymieniono wszystkie możliwe wartości wpisu LoadBehavior . Niektóre opisy w tej tabeli dotyczą ręcznego lub programowego ładowania dodatku VSTO. Aby ręcznie załadować dodatek VSTO, zaznacz pole wyboru obok dodatku VSTO w oknie dialogowym Dodatki COM w aplikacji. Aby programowo załadować dodatek VSTO, ustaw Connect właściwość COMAddIn obiektu reprezentującego dodatek VSTO na true.

Wartość (w liczbach dziesiętnych) Stan dodatku VSTO Zachowanie ładowania dodatku VSTO opis
0 Zwolniono Nie ładuj automatycznie Aplikacja nigdy nie próbuje automatycznie załadować dodatku VSTO. Użytkownik może spróbować ręcznie załadować dodatek VSTO lub dodatek VSTO można załadować programowo.

Jeśli dodatek VSTO został pomyślnie załadowany, wartość LoadBehavior pozostaje 0, ale stan dodatku VSTO w oknie dialogowym Dodatki COM jest aktualizowany, aby wskazać, że dodatek VSTO jest ładowany.
1 załadowano Nie ładuj automatycznie Aplikacja nigdy nie próbuje automatycznie załadować dodatku VSTO. Użytkownik może spróbować ręcznie załadować dodatek VSTO lub dodatek VSTO można załadować programowo.

Mimo że okno dialogowe Dodatki COM wskazuje, że dodatek VSTO jest ładowany po uruchomieniu aplikacji, dodatek VSTO nie jest ładowany, dopóki nie zostanie załadowany ręcznie lub programowo.

Jeśli aplikacja pomyślnie ładuje dodatek VSTO, wartość LoadBehavior zmieni się na 0 i pozostanie na 0 po zamknięciu aplikacji.
2 Zwolniono Ładowanie przy uruchamianiu Aplikacja nie próbuje automatycznie załadować dodatku VSTO. Użytkownik może spróbować ręcznie załadować dodatek VSTO lub dodatek VSTO można załadować programowo.

Jeśli aplikacja pomyślnie ładuje dodatek VSTO, wartość LoadBehavior zmieni się na 3 i pozostanie na 3 po zamknięciu aplikacji.
3 załadowano Ładowanie przy uruchamianiu Aplikacja próbuje załadować dodatek VSTO po uruchomieniu aplikacji. Jest to wartość domyślna podczas tworzenia lub publikowania dodatku VSTO w programie Visual Studio.

Jeśli aplikacja pomyślnie ładuje dodatek VSTO, wartość LoadBehavior pozostanie 3. Jeśli podczas ładowania dodatku VSTO wystąpi błąd, wartość LoadBehavior zmieni się na 2 i pozostaje na 2 po zamknięciu aplikacji.
8 Zwolniono Obciążenie na żądanie Aplikacja nie próbuje automatycznie załadować dodatku VSTO. Użytkownik może spróbować ręcznie załadować dodatek VSTO lub dodatek VSTO można załadować programowo.

Jeśli aplikacja pomyślnie ładuje dodatek VSTO, wartość LoadBehavior zmieni się na 9.
9 załadowano Obciążenie na żądanie Dodatek VSTO zostanie załadowany tylko wtedy, gdy aplikacja będzie jej wymagała. Na przykład gdy użytkownik wybierze element interfejsu użytkownika, który używa funkcji w dodatku VSTO (na przykład przycisk niestandardowy na wstążce).

Jeśli aplikacja pomyślnie ładuje dodatek VSTO, wartość LoadBehavior pozostaje 9, ale stan dodatku VSTO w oknie dialogowym Dodatki COM jest aktualizowany, aby wskazać, że dodatek VSTO jest obecnie załadowany. Jeśli podczas ładowania dodatku VSTO wystąpi błąd, wartość LoadBehavior zmieni się na 8.
16 załadowano Ładowanie po raz pierwszy, a następnie ładowanie na żądanie Ustaw tę wartość, jeśli chcesz, aby dodatek VSTO był ładowany na żądanie. Aplikacja ładuje dodatek VSTO, gdy użytkownik uruchamia aplikację po raz pierwszy. Przy następnym uruchomieniu aplikacji aplikacja ładuje wszystkie elementy interfejsu użytkownika zdefiniowane przez dodatek VSTO. Jednak dodatek VSTO nie jest ładowany, dopóki użytkownik nie wybierze elementu interfejsu użytkownika skojarzonego z dodatkiem VSTO.

Gdy aplikacja pomyślnie ładuje dodatek VSTO po raz pierwszy, wartość LoadBehavior pozostaje 16 podczas ładowania dodatku VSTO. Po zamknięciu aplikacji wartość LoadBehavior zmieni się na 9.

Powiązana zawartość