Registrierungseinträge für VSTO-Add-Ins

  • Artikel

Sie müssen einen bestimmten Satz von Registrierungseinträgen erstellen, wenn Sie VSTO-Add-Ins bereitstellen, die mithilfe von Visual Studio erstellt werden. Diese Registrierungseinträge enthalten Informationen, mit denen die Microsoft Office-Anwendung das VSTO-Add-In erkennt und lädt.

Gilt für: Die Informationen in diesem Thema gelten für VSTO-Add-In-Projekte. Weitere Informationen finden Sie unter features available by Office-App lication and project type.

Hinweis

Möchten Sie Lösungen entwickeln, die die Office-Erfahrung auf mehreren Plattformen erweitern? Schauen Sie sich das neue Office-Add-Ins-Modell an. Office-Add-Ins haben im Vergleich zu VSTO-Add-Ins und -Lösungen einen geringen Platzbedarf, und Sie können diese mithilfe nahezu jeder Webprogrammiertechnologie erstellen, z. B. HTML5, JavaScript, CSS3 und XML.

Wenn Sie Ihr Projekt erstellen, erstellt Visual Studio diese Registrierungseinträge auf dem Entwicklungscomputer. Auf diese Weise können Sie das VSTO-Add-In ganz einfach ausführen und debuggen. Mithilfe von ClickOnce zum Bereitstellen Ihres VSTO-Add-Ins werden die Registrierungseinträge automatisch auf dem Endbenutzercomputer erstellt.

Weitere Informationen zum Bereitstellen einer VSTO-Lösung mit Windows Installer finden Sie unter Bereitstellen einer VSTO-Lösung mit Windows Installer.

Weitere Informationen zur Verwendung der Registrierungseinträge während des Ladevorgangs für VSTO-Add-Ins finden Sie unter Architecture of VSTO Add-ins.

Hinweis

In diesem Thema stellt der Text Add-In-ID eine eindeutige ID für das VSTO-Add-In dar. Standardmäßig entspricht die ID dem Namen der VSTO-Add-In-Assembly.

Registrieren von VSTO-Add-Ins für den aktuellen Benutzer im Vergleich zu allen Benutzern

Wenn ein VSTO-Add-In installiert ist, kann es auf zwei Arten registriert werden:

  • Nur für den aktuellen Benutzer (Das VSTO-Add-In ist nur für den Benutzer verfügbar, der beim Installieren des Add-Ins am Computer angemeldet war). In diesem Fall werden die Registrierungseinträge unter dem HKEY_CURRENT_USER erstellt.

  • Für alle Benutzer (d. a. jeder Benutzer, der sich beim Computer anmeldet, kann das VSTO-Add-In verwenden). In diesem Fall werden die Registrierungseinträge unter HKEY_LOCAL_MACHINE erstellt.

    Alle VSTO-Add-Ins, die Sie mit Visual Studio erstellen, können für den aktuellen Benutzer registriert werden. VSTO-Add-Ins können für alle Benutzer jedoch nur in bestimmten Szenarien registriert werden. Diese Szenarien hängen von der Version von Microsoft Office auf dem Computer und davon ab, wie das VSTO-Add-In bereitgestellt wurde.

Bereitstellungstyp

Wenn Sie ClickOnce verwenden, um ein VSTO-Add-In bereitzustellen, kann das VSTO-Add-In nur für den aktuellen Benutzer registriert werden. Dies liegt daran, dass ClickOnce nur das Erstellen von Schlüsseln unter HKEY_CURRENT_USER unterstützt. Wenn Sie ein VSTO-Add-In für alle Benutzer auf einem Computer registrieren möchten, müssen Sie Windows Installer verwenden, um das VSTO-Add-In bereitzustellen. Weitere Informationen zu diesen Bereitstellungstypen finden Sie unter Bereitstellen einer Office-Lösung mithilfe von ClickOnce und Bereitstellen einer Office-Lösung mithilfe von Windows Installer.

Registrierungseinträge

Die erforderlichen VSTO-Add-In-Registrierungseinträge befinden sich unter den folgenden Registrierungsschlüsseln, bei denen Root HKEY_CURRENT_USER oder HKEY_LOCAL_MACHINE ist, je nachdem, ob die Installation für den aktuellen Benutzer oder alle Benutzer vorgesehen ist.

Office-Anwendung Konfigurationspfad
Visio Root\Software\Microsoft\Visio\Addins\Add-In-ID
Alle anderen Root\Software\Microsoft\Office\Office-App lication name\Addins\add-in ID

Hinweis

Wenn das Installationsprogramm auf alle Benutzer unter 64-Bit-Windows ausgerichtet ist, wird empfohlen, dass es zwei Registrierungseinträge enthält, eine unter der HKEY_LOCAL_MACHINE\Software\Microsoft und eine unter der HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft hive. Dies liegt daran, dass Benutzer entweder 32-Bit- oder 64-Bit-Versionen von Office auf dem Computer verwenden können.

Wenn der Installer auf den aktuellen Benutzer ausgerichtet ist, muss er nicht auf wow6432Node installiert werden, da der pfad "HKEY_CURRENT_USER\Software" freigegeben ist.

Weitere Informationen finden Sie unter 32-Bit- und 64-Bit-Anwendungsdaten in der Registrierung.

In der folgenden Tabelle werden die Einträge in diesem Registrierungsschlüssel aufgeführt.

Eingabe type Wert
Beschreibung REG_SZ Erforderlich. Eine kurze Beschreibung des VSTO-Add-Ins.

Diese Beschreibung wird angezeigt, wenn der Benutzer das VSTO-Add-In in der Microsoft Office-Anwendung im Dialogfeld Optionen im Bereich Add-Ins auswählt.
FriendlyName REG_SZ Erforderlich. Ein beschreibender Name des VSTO-Add-Ins, der in der Microsoft Office-Anwendung im Dialogfeld COM-Add-Ins angezeigt wird. Der Standardwert ist die ID des VSTO-Add-Ins.
LoadBehavior REG_DWORD Erforderlich. Ein Wert, der zusätzlich zum aktuellen Zustand des VSTO-Add-Ins (geladen oder entladen) angibt, wann die Anwendung das VSTO-Add-In laden soll.

Standardmäßig ist dieser Wert auf 3 festgelegt, was bedeutet, dass das VSTO-Add-In beim Start geladen wird. Weitere Informationen finden Sie unter LoadBehavior-Werte.

Hinweis: Wenn ein Benutzer das VSTO-Add-In deaktiviert, ändert diese Aktion den LoadBehavior-Wert in der HKEY_CURRENT_USER Registrierungsstruktur. Für jeden Benutzer überschreibt der Wert des LoadBehavior-Werts in der HKEY_CURRENT_USER Struktur die in der HKEY_LOCAL_MACHINE Struktur definierte StandardlastBehavior.
Manifest REG_SZ Erforderlich. Der vollständige Pfad des Bereitstellungsmanifests für das VSTO-Add-In. Bei dem Pfad kann es sich um einen Speicherort auf dem lokalen Computer, eine Netzwerkfreigabe (UNC) oder um einen Webserver (HTTP) handeln.

Wenn Sie Windows Installer zum Bereitstellen der Lösung verwenden, müssen Sie das Präfix file:/// zum Manifestpfad hinzufügen. Sie müssen auch die Zeichenfolge |vstolocal (d. h. das Pipezeichen | gefolgt von vstolocal) an das Ende dieses Pfads anfügen. Dadurch wird sichergestellt, dass die Projektmappe aus dem Installationsordner geladen wird und nicht aus dem ClickOnce-Cache. Weitere Informationen finden Sie unter Bereitstellen einer Office-Lösung mithilfe von Windows Installer.

Hinweis: Wenn Sie ein VSTO-Add-In auf dem Entwicklungscomputer erstellen, fügt Visual Studio automatisch die Zeichenfolge |vstolocal an diesen Registrierungseintrag an.

Registrierungseinträge für Outlook-Formularbereiche

Wenn Sie einen benutzerdefinierten Formularbereich in einem VSTO-Add-In für Outlook erstellen, werden zusätzliche Registrierungseinträge verwendet, um den Formularbereich für Outlook zu registrieren. Diese Einträge werden unter einem anderen Registrierungsschlüssel für jede Nachrichtenklasse erstellt, die vom Formularbereich unterstützt wird. Diese Registrierungsschlüssel befinden sich am folgenden Speicherort, an dem Root HKEY_CURRENT_USER oder HKEY_LOCAL_MACHINE ist.

Root\Software\Microsoft\Office\Outlook\FormRegions\message class

Wie die anderen von allen VSTO-Add-Ins verwendeten Registrierungseinträge erstellt auch Visual Studio beim Erstellen des Projekts die Formularbereich-Registrierungseinträge auf dem Entwicklungscomputer. Mithilfe von ClickOnce zum Bereitstellen Ihres VSTO-Add-Ins werden die Registrierungseinträge automatisch auf dem Endbenutzercomputer erstellt. Wenn Sie Windows Installer zum Bereitstellen Ihres VSTO-Add-Ins verwenden, müssen Sie das InstallShield Limited Edition-Projekt konfigurieren, um die Registrierungseinträge auf dem Endbenutzercomputer zu erstellen.

Weitere Informationen zu den Registrierungseinträgen des Formularbereichs finden Sie unter Angeben des Speicherorts eines Formularbereichs in einem benutzerdefinierten Formular. Weitere Informationen zu Outlook-Formularbereichen finden Sie unter Erstellen von Outlook-Formularbereichen.

LoadBehavior-Werte

Der LoadBehavior-Eintrag unter dem Stamm\Software\Microsoft\Office\Anwendungsname\Addins\Add-In-ID-Schlüssel enthält eine bitweise Kombination von Werten, die das Laufzeitverhalten des VSTO-Add-Ins angeben. Das Bit der niedrigsten Ordnung (Werte 0 und 1) gibt an, ob das VSTO-Add-In gerade geladen ist. Andere Bits geben an, wann die Anwendung versucht, das VSTO-Add-In zu laden.

Normalerweise ist der LoadBehavior-Eintrag auf 0, 3 oder 16 (dezimal) festgelegt, wenn das VSTO-Add-In auf Endbenutzercomputern installiert wird. Standardmäßig legt Visual Studio den LoadBehavior -Eintrag des VSTO-Add-Ins auf 3 fest, wenn Sie es erstellen oder veröffentlichen.

In der folgenden Tabelle sind alle möglichen Werte für den LoadBehavior -Eintrag aufgeführt. Einige Beschreibungen in dieser Tabelle verweisen auf das manuelle oder programmgesteuerte Laden eines VSTO-Add-Ins. Um ein VSTO-Add-In manuell zu laden, aktivieren Sie das Kontrollkästchen neben dem VSTO-Add-In im Dialogfeld COM-Add-Ins in der Anwendung. Um ein VSTO-Add-In programmgesteuert zu laden, legen Sie die Connect -Eigenschaft des COMAddIn -Objekts, mit dem das VSTO-Add-In dargestellt wird, auf true.

Dezimalwert VSTO-Add-In-Status VSTO-Add-In-Ladeverhalten Beschreibung
0 Nicht Geladen Automatisches Laden nicht Die Anwendung versucht nie, das VSTO-Add-In beim Start automatisch zu laden. Der Benutzer kann das VSTO-Add-In manuell laden, oder das VSTO-Add-In kann programmgesteuert geladen werden.

Wenn das VSTO-Add-In erfolgreich geladen wird, bleibt der LoadBehavior -Wert 0. Der Status des VSTO-Add-Ins im Dialogfeld COM-Add-Ins wird aber aktualisiert, um anzugeben, dass das VSTO-Add-In geladen wird.
1 Geladen Automatisches Laden nicht Die Anwendung versucht nie, das VSTO-Add-In beim Start automatisch zu laden. Der Benutzer kann das VSTO-Add-In manuell laden, oder das VSTO-Add-In kann programmgesteuert geladen werden.

Obwohl das Dialogfeld COM-Add-Ins angibt, dass das VSTO-Add-In nach dem Start der Anwendung geladen wird, wird das VSTO-Add-In erst geladen, wenn es manuell oder programmgesteuert geladen wird.

Wenn die Anwendung das VSTO-Add-In erfolgreich lädt, ändert sich der LoadBehavior -Wert in 0 und bleibt nach dem Schließen der Anwendung weiterhin 0.
2 Nicht Geladen Beim Starten laden Die Anwendung versucht nicht, das VSTO-Add-In automatisch zu laden. Der Benutzer kann das VSTO-Add-In manuell laden, oder das VSTO-Add-In kann programmgesteuert geladen werden.

Wenn die Anwendung das VSTO-Add-In erfolgreich lädt, ändert sich der LoadBehavior -Wert in 3 und bleibt nach dem Schließen der Anwendung weiterhin 3.
3 Geladen Beim Starten laden Die Anwendung versucht, das VSTO-Add-In beim Starten zu laden. Dies ist der Standardwert, wenn Sie ein VSTO-Add-In in Visual Studio erstellen oder veröffentlichen.

Wenn die Anwendung das VSTO-Add-In erfolgreich lädt, bleibt der LoadBehavior -Wert 3. Wenn beim Laden des VSTO-Add-Ins ein Fehler auftritt, ändert sich der LoadBehavior -Wert in 2 und bleibt nach dem Schließen der Anwendung weiterhin 2.
8 Nicht Geladen Bedarfsgesteuert laden Die Anwendung versucht nicht, das VSTO-Add-In automatisch zu laden. Der Benutzer kann das VSTO-Add-In manuell laden, oder das VSTO-Add-In kann programmgesteuert geladen werden.

Wenn die Anwendung das VSTO-Add-In erfolgreich lädt, ändert sich der LoadBehavior -Wert in 9.
9 Geladen Bedarfsgesteuert laden Das VSTO-Add-In wird nur geladen, wenn die Anwendung sie benötigt. Beispielsweise, wenn ein Benutzer ein UI-Element auswählt, das Funktionen im VSTO-Add-In verwendet (z. B. eine benutzerdefinierte Schaltfläche im Menüband).

Wenn die Anwendung das VSTO-Add-In erfolgreich lädt, bleibt der LoadBehavior -Wert 9. Der Status des VSTO-Add-Ins im Dialogfeld COM-Add-Ins wird aber aktualisiert, um anzugeben, dass das VSTO-Add-In momentan geladen ist. Wenn beim Laden des VSTO-Add-Ins ein Fehler auftritt, ändert sich der LoadBehavior -Wert in 8.
16 Geladen Beim ersten Mal laden, dann bedarfsgesteuert laden Legen Sie diesen Wert fest, wenn Sie das VSTO-Add-In bedarfsgesteuert laden möchten. Die Anwendung lädt das VSTO-Add-In, wenn der Benutzer die Anwendung das erste Mal ausführt. Wenn der Benutzer die Anwendung das nächste Mal ausführt, lädt die Anwendung alle UI-Elemente, die vom VSTO-Add-In definiert sind. Das VSTO-Add-In wird jedoch erst geladen, wenn der Benutzer ein Ui-Element auswählt, das dem VSTO-Add-In zugeordnet ist.

Wenn die Anwendung das VSTO-Add-In zum ersten Mal erfolgreich lädt, bleibt der LoadBehavior -Wert 16, während das VSTO-Add-In geladen ist. Nachdem die Anwendung geschlossen wurde, ändert sich der LoadBehavior -Wert in 9.

Zugehöriger Inhalt