Architektur von Anpassungen auf Dokumentebene

Artikel
08/10/2011

Visual Studio 2010 enthält Projekte für das Erstellen von Anpassungen auf Dokumentebene für Microsoft Office Word und Microsoft Office Excel. In diesem Thema werden die folgenden Aspekte von Anpassungen auf Dokumentebene beschrieben:

Anpassungen
Komponenten von Anpassungen
Verwenden von Anpassungen mit Microsoft Office-Anwendungen

Betrifft: Die Informationen in diesem Thema betreffen Projekte auf Dokumentebene für die folgenden Anwendungen: Excel 2007 und Excel 2010, Word 2007 und Word 2010. Weitere Informationen finden Sie unter Verfügbare Funktionen nach Office-Anwendung und Projekttyp.

Allgemeine Informationen zum Erstellen von Anpassungen auf Dokumentebene finden Sie unter Übersicht über die Entwicklung von Office-Projektmappen, Erste Schritte: Programmieren von Anpassungen auf Dokumentebene für Word und Erste Schritte beim Programmieren von Anpassungen auf Dokumentebene für Excel.

Anpassungen

Wenn Sie zum Erstellen einer Anpassung auf Dokumentebene die Office-Entwicklertools in Visual Studio verwenden, erstellen Sie eine verwaltete Codeassembly, die einem bestimmten Dokument zugeordnet ist. Ein Dokument oder eine Arbeitsmappe mit einer zugeordneten Assembly besitzt Erweiterungen durch verwalteten Code. Weitere Informationen hierzu finden Sie unter Übersicht über Assemblys in Office-Projektmappen.

Wenn ein Benutzer das Dokument öffnet, wird die Assembly von der Microsoft Office-Anwendung geladen. Nach dem Laden der Assembly kann die Anpassung auf Ereignisse reagieren, während das Dokument geöffnet ist. Die Anpassung kann auch einen Aufruf an das Objektmodell ausführen, um die Anwendung zu automatisieren und zu erweitern, während das Dokument geöffnet ist, und die Anpassung kann jede der Klassen in .NET Framework verwenden.

Die Assembly verwendet die primäre Interopassembly der Anwendung, um mit den COM-Komponenten der Anwendung zu kommunizieren. Weitere Informationen finden Sie unter Primäre Interopassemblys in Office und Übersicht über die Entwicklung von Office-Projektmappen.

Wenn ein Benutzer mehrere Anpassungen auf Dokumentebene gleichzeitig öffnet, wird jede Assembly in eine andere Anwendungsdomäne geladen. So kann eine Projektmappe, die sich falsch verhält, nicht bewirken, dass andere Projektmappen fehlschlagen. Anpassungen auf Dokumentebene sind für einzelne Dokumente in einer einzelnen Anwendungsdomäne konzipiert. Sie sind nicht für die Kommunikation zwischen verschiedenen Dokumenten konzipiert. Weitere Informationen zu Anwendungsdomänen finden Sie unter Anwendungsdomänen.

Tipp

Anpassungen auf Dokumentebene, die mit den Office-Entwicklertools in Visual Studio erstellt werden, sollen nur dann verwendet werden, wenn die Microsoft Office-Hostanwendung von einem Endbenutzer gestartet wird. Wird die Anwendung programmgesteuert gestartet, (beispielsweise durch Automatisierung), verhält sich die Anpassung unter Umständen nicht so, wie erwartet.

Möglichkeiten zur Entwurfszeit und Laufzeit

Um die Architektur von Anpassungen auf Dokumentebene zu verstehen, ist es hilfreich, wenn Sie die Möglichkeiten beim Entwerfen und beim Ausführen einer Lösung kennen.

Entwurfszeit

Zur Entwurfszeit werden die folgenden Schritte ausgeführt:

Der Entwickler erstellt ein Projekt auf Dokumentebene in Visual Studio. Das Projekt enthält das Dokument und die Assembly, die im Dokument ausgeführt wird. Das Dokument kann bereits vorhanden sein (z. B. von einem Designer erstellt), oder es kann mit dem Projekt erstellt werden.
Der Designer (d. h. der Entwickler, der das Projekt erstellt, oder eine andere Person) bestimmt die endgültige Gestaltung des Dokuments für den Endbenutzer.

Laufzeit

Zur Laufzeit werden die folgenden Schritte ausgeführt:

Der Endbenutzer öffnet ein Dokument oder eine Arbeitsmappe, die Erweiterungen durch verwalteten Code besitzt.
Die kompilierte Assembly wird vom Dokument oder der Arbeitsmappe geladen.
Die Assembly reagiert auf Ereignisse, während der Benutzer im Dokument oder in der Arbeitsmappe arbeitet.

Die Perspektive des Entwicklers und des Endbenutzers im Vergleich

Für Anpassungen auf Dokumentebene gibt es zwei verschiedene Erklärungsansätze, da Entwickler überwiegend Visual Studio verwenden, während Endbenutzer mit Word oder Excel arbeiten.

Perspektive des Entwicklers	Perspektive des Endbenutzers
Der Entwickler erstellt in Visual Studio Code, auf den aus Word und Excel zugegriffen werden kann. Auch wenn der Eindruck entsteht, der Entwickler erstelle eine ausführbare Datei, die Word oder Excel ausführt, verläuft der Prozess umgekehrt. Das Dokument ist einer Assembly zugeordnet und enthält einen Zeiger auf diese Assembly. Beim Öffnen des Dokuments sucht Word bzw. Excel die Assembly und führt den Code als Reaktion auf alle behandelten Ereignisse aus.	Die Benutzer der Projektmappe öffnen einfach das Dokument bzw. die Arbeitsmappe (oder erstellen ein neues Dokument aus einer Vorlage) wie bei einer normalen Microsoft Office-Datei. Die Assembly stellt Anpassungen im Dokument bzw. in der Arbeitsmappe bereit, z. B. das automatische Füllen mit aktuellen Daten oder das Anzeigen eines Dialogfelds zum Abfragen von Informationen.

Der Entwickler erstellt in Visual Studio Code, auf den aus Word und Excel zugegriffen werden kann.

Auch wenn der Eindruck entsteht, der Entwickler erstelle eine ausführbare Datei, die Word oder Excel ausführt, verläuft der Prozess umgekehrt. Das Dokument ist einer Assembly zugeordnet und enthält einen Zeiger auf diese Assembly. Beim Öffnen des Dokuments sucht Word bzw. Excel die Assembly und führt den Code als Reaktion auf alle behandelten Ereignisse aus.

Die Benutzer der Projektmappe öffnen einfach das Dokument bzw. die Arbeitsmappe (oder erstellen ein neues Dokument aus einer Vorlage) wie bei einer normalen Microsoft Office-Datei.

Die Assembly stellt Anpassungen im Dokument bzw. in der Arbeitsmappe bereit, z. B. das automatische Füllen mit aktuellen Daten oder das Anzeigen eines Dialogfelds zum Abfragen von Informationen.

Unterstützte Dokumentformate für Anpassungen auf Dokumentebene

Wenn Sie ein Anpassungsprojekt erstellen, können Sie das Format des Dokuments auswählen, das Sie im Projekt verwenden möchten. Weitere Informationen hierzu finden Sie unter Gewusst wie: Erstellen von Office-Projekten in Visual Studio.

In der folgenden Tabelle werden die Dokumentformate aufgelistet, die Sie in Anpassungen auf Dokumentebene für Excel und Word verwenden können.

Excel	Word
Excel-Arbeitsmappe (.xlsx) Excel-Arbeitsmappe mit Makros (.xlsm) Binäre Excel-Arbeitsmappe (.xlsb) Excel 97-2003-Arbeitsmappe (.xls) Excel-Vorlage (.xltx) Excel-Vorlage mit Makros (.xltm) Excel 97-2003-Vorlage (.xlt)	Word-Dokument (.docx) Word-Dokument mit Makros (.docm) Word 97-2003-Dokument (.doc) Word-Vorlage (.dotx) Word-Vorlage mit Makros (.dotm) Word 97-2003-Vorlage (.dot)

Excel-Arbeitsmappe (.xlsx)

Excel-Arbeitsmappe mit Makros (.xlsm)

Binäre Excel-Arbeitsmappe (.xlsb)

Excel 97-2003-Arbeitsmappe (.xls)

Excel-Vorlage (.xltx)

Excel-Vorlage mit Makros (.xltm)

Excel 97-2003-Vorlage (.xlt)

Word-Dokument (.docx)

Word-Dokument mit Makros (.docm)

Word 97-2003-Dokument (.doc)

Word-Vorlage (.dotx)

Word-Vorlage mit Makros (.dotm)

Word 97-2003-Vorlage (.dot)

Sie sollten Erweiterungen durch verwalteten Code nur für Dokumente in den unterstützten Formaten entwerfen. Andernfalls können bestimmte Ereignisse möglicherweise nicht ausgelöst werden, wenn das Dokument in der Anwendung geöffnet wird. Das Open-Ereignis wird beispielsweise nicht ausgelöst, wenn Sie Erweiterungen durch verwalteten Code in Arbeitsmappen verwenden, die im XML-Arbeitsblattformat für Excel oder im Webseitenformat (HTM, HTML) gespeichert wurden.

Unterstützung für Word-Dokumente mit .xml-Dateinamenerweiterungen

Mit Projektvorlagen auf Dokumentebene können Sie keine Projekte erstellen, die auf den folgenden Dateiformaten basieren:

XML-Dokument für Word (*xml)
XML-Dokument für Word 2003 (*xml)

Wenn Sie möchten, dass die Endbenutzer Anpassungen in diesen Dateiformaten verwenden, erstellen Sie eine Anpassung, die eines der unterstützten Dateiformate aus der Tabelle oben verwendet, und stellen Sie diese Anpassung bereit. Nach der Installation der Anpassung können Endbenutzer das Dokument im XML-Dokumentformat für Word (*xml) oder im XML-Dokumentformat für Word 2003 (*xml) speichern, und die Anpassung funktioniert weiterhin wie erwartet.

Komponenten von Anpassungen

Die Hauptkomponenten einer Anpassung sind das Dokument und die Assembly. Es gibt zudem mehrere andere Komponenten, die beeinflussen, wie Microsoft Office-Anwendungen Anpassungen finden und laden.

Bereitstellungsmanifest und Anwendungsmanifest

Anwendungen verwenden Bereitstellungs- und Anwendungsmanifeste, um die aktuelle Version der Anpassungsassembly zu identifizieren und zu laden. Das Bereitstellungsmanifest verweist auf das aktuelle Anwendungsmanifest. Das Anwendungsmanifest verweist auf die Anpassungsassembly und gibt die Einstiegspunktklasse (bzw. Einstiegspunktklassen) an, die in der Assembly ausgeführt wird. Weitere Informationen finden Sie unter Anwendungs- und Bereitstellungsmanifeste in Office-Projektmappen.

Visual Studio Tools for Office Runtime

Zum Ausführen von mit den Office-Entwicklertools in Visual Studio erstellten Anpassungen auf Dokumentebene muss auf den Endbenutzercomputern Visual Studio Tools for Office-Laufzeit installiert sein. Visual Studio Tools for Office-Laufzeit enthält nicht verwaltete Komponenten, die die Anpassungsassembly laden, und einen Satz verwalteter Assemblys. Die verwalteten Assemblys enthalten das Objektmodell, das Ihr Anpassungscode verwendet, um die Hostanwendung zu automatisieren und zu erweitern.

Weitere Informationen finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.

Verwenden von Anpassungen mit Microsoft Office-Anwendungen

Wenn ein Benutzer ein Dokument öffnet, das Teil einer Anpassung für Microsoft Office ist, verwendet die Anwendung das mit dem Dokument verknüpfte Bereitstellungsmanifest, um die aktuelle Version der Anpassungsassembly zu finden und zu laden. Der Speicherort des Bereitstellungsmanifests wird in einer benutzerdefinierten Dokumenteigenschaft mit dem Namen _AssemblyLocation gespeichert. Die Zeichenfolge, die diesen Speicherort angibt, wird in die Eigenschaft eingefügt, wenn Sie die Projektmappe erstellen.

Das Bereitstellungsmanifest verweist auf das Anwendungsmanifest, das wiederum auf die aktuelle Assembly verweist. Weitere Informationen finden Sie unter Anwendungs- und Bereitstellungsmanifeste in Office-Projektmappen.

In der folgenden Abbildung wird die grundlegende Architektur einer Anpassung auf Dokumentebene dargestellt.

Anpassungsarchitektur

Office 2007-Anpassungsarchitektur

Tipp

In Office-Lösungen, die auf .NET Framework 4 abzielen, rufen Lösungen das Objektmodell der Hostanwendung mithilfe von in die Lösungsassembly eingebetteten PIA-Typinformationen auf, statt die PIA direkt aufzurufen. Weitere Informationen finden Sie unter Entwerfen und Erstellen von Office-Lösungen.

Ladevorgang

Die folgenden Schritte werden ausgeführt, wenn ein Benutzer ein Dokument öffnet, das Teil einer Microsoft Office-Lösung ist:

Die Microsoft Office-Anwendung prüft anhand der benutzerdefinierten Dokumenteigenschaften, ob dem Dokument Erweiterungen durch verwalteten Code zugeordnet sind. Weitere Informationen finden Sie unter Übersicht über benutzerdefinierte Dokumenteigenschaften.
Wenn Erweiterungen durch verwalteten Code vorhanden sind, lädt die Anwendung die Datei VSTOEE.dll, die dann die Datei VSTOLoader.dll lädt. Hierbei handelt es sich um nicht verwaltete DLLs, die die Ladeprogrammkomponenten für Visual Studio 2010-Tools for Office-Laufzeit sind. Weitere Informationen finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.
VSTOLoader.dll lädt .NET Framework und startet den verwalteten Teil von Visual Studio Tools for Office-Laufzeit.
Wenn das Dokument von einem anderen Speicherort als dem lokalen Computer aus geöffnet wird, überprüft Visual Studio Tools for Office-Laufzeit, ob der Speicherort des Dokuments in der Liste der vertrauenswürdigen Speicherorte in den Einstellungen für das Sicherheitscenter der betreffenden Office-Anwendung aufgeführt wird. Wenn der Speicherort des Dokuments kein vertrauenswürdiger Speicherort ist, ist die Anpassung nicht vertrauenswürdig, und der Ladevorgang wird hier beendet.
Visual Studio Tools for Office-Laufzeit installiert die Lösung, wenn sie nicht bereits installiert ist, lädt das aktuelle Anwendungs- und Bereitstellungsmanifest herunter, und führt eine Reihe von Sicherheitsüberprüfungen durch. Weitere Informationen finden Sie unter Sichern von Office-Projektmappen.
Wenn die Anpassung vertrauenswürdig ist und ausgeführt werden darf, verwendet Visual Studio Tools for Office-Laufzeit das Bereitstellungsmanifest und das Anwendungsmanifest, um nach Assemblyaktualisierungen zu suchen. Wenn eine neue Version der Assembly verfügbar ist, lädt die Laufzeit die neue Version der Assembly in den ClickOnce-Cache auf dem Clientcomputer. Weitere Informationen finden Sie unter Bereitstellen von Office-Projektmappen.
Visual Studio Tools for Office-Laufzeit erstellt eine neue Anwendungsdomäne, in der die Anpassungsassembly geladen wird.
Die Anpassungsassembly wird von Visual Studio Tools for Office-Laufzeit in die Anwendungsdomäne geladen.
Visual Studio Tools for Office-Laufzeit ruft den Startup-Ereignishandler in der Anpassungsassembly auf. Weitere Informationen finden Sie unter Ereignisse in Office-Projekten.