Verwalten von Dokumenten auf einem Server mit der ServerDocument-Klasse

Mit der ServerDocument-Klasse in der Visual Studio-Tools für Office-Laufzeit können Sie mehrere Aspekte von Anpassungen auf Dokumentebene verwalten, selbst wenn Microsoft Office Word und Microsoft Office Excel nicht installiert sind.Sie können die folgenden Aufgaben ausführen:

  • Zugreifen auf und Ändern von Daten im Datencache eines Dokuments oder einer Arbeitsmappe.Weitere Informationen finden Sie unter Arbeiten mit im Dokument zwischengespeicherten Daten.

  • Verwalten der Anpassungsassembly, die einem Dokument zugeordnet ist.Weitere Informationen finden Sie unter Verwalten der Dokumentanpassung.

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

Die ServerDocument-Klasse

Die ServerDocument-Klasse kann auf Computern verwendet werden, auf denen Office nicht installiert ist.Daher wird diese Klasse üblicherweise in Anwendungen verwendet, die nicht in Office integriert sind, z. B. Konsolenprojekte oder Windows Forms-Projekte, im Gegensatz zu Office-Projekten.Verwenden Sie die Microsoft.VisualStudio.Tools.Applications.ServerDocument-Klasse in der Assembly Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll.

Die ServerDocument-Klasse kann verwendet werden, um Anpassungen an auszuführen auf Dokumentebene, die erstellt wurden, indem Visual Studio 2012 verwendet.

Weitere Informationen über Visual Studio 2010 Tools for Office Ablaufzeit und die Office-Erweiterungen für .NET Framework, finden Sie unter Übersicht über die Visual Studio Tools for Office-Laufzeit.

HinweisHinweis

Wenn Sie eine ältere Anwendung verfügen, die die ServerDocument-Klasse in der Visual Studio Tools for Office-System (Version 3.0) verwendet, müssen die Visual Studio-Tools für Office-System (Version 3.0) auf Computern installiert werden, die die Anwendung ausführen.Die Visual Studio 2010 Tools for Office Runtime können diese Anwendungen nicht ausführen.

Arbeiten mit im Dokument zwischengespeicherten Daten

Die ServerDocument-Klasse stellt Member bereit, die Sie verwenden können, um mit dem Datencache in angepassten Dokumenten zu arbeiten.Weitere Informationen über zwischengespeicherte Daten finden Sie unter Zwischenspeichern von Daten und unter Zugreifen auf Daten in Dokumenten auf dem Server.

In der folgenden Tabelle werden die Member aufgeführt, die Sie verwenden können, um mit zwischengespeicherten Daten zu arbeiten.

Aufgabe

Zu verwendender Member

Bestimmen, ob ein Dokument über einen Datencache verfügt

Die IsCacheEnabled-Methode

Zugreifen auf die zwischengespeicherten Daten in einem Dokument

Weitere Informationen finden Sie unter Zugreifen auf Daten in Dokumenten auf dem Server.

Die CachedData-Eigenschaft

Verwalten der Dokumentanpassung

Sie können Member der ServerDocument-Klasse zum Verwalten der Anpassungsassembly verwenden, die einem Dokument zugeordnet ist.Sie können z. B. die Anpassung aus einem Dokument programmgesteuert entfernen, sodass das Dokument nicht mehr Teil einer Anpassung ist.

In der folgenden Tabelle werden die Member, mit denen Sie die Anpassungsassembly verwalten können, aufgeführt.

Aufgabe

Zu verwendender Member

Ermitteln, ob ein Dokument Teil einer Anpassung auf Dokumentebene ist

Die GetCustomizationVersion-Methode

Programmgesteuertes Anfügen einer Anpassung an ein Dokument zur Laufzeit

Weitere Informationen finden Sie unter Gewusst wie: Anfügen von Erweiterungen durch verwalteten Code an Dokumente.

Eine der AddCustomization-Methoden

Programmgesteuertes Entfernen einer Anpassung aus einem Dokument zur Laufzeit

Weitere Informationen finden Sie unter Gewusst wie: Entfernen von Erweiterungen durch verwalteten Code aus Dokumenten.

Die RemoveCustomization-Methode

Abrufen der URL des Bereitstellungsmanifests, das dem Dokument zugeordnet ist

Die DeploymentManifestUrl-Eigenschaft

Siehe auch

Aufgaben

Gewusst wie: Anfügen von Erweiterungen durch verwalteten Code an Dokumente

Gewusst wie: Entfernen von Erweiterungen durch verwalteten Code aus Dokumenten

Referenz

Microsoft.VisualStudio.Tools.Applications.ServerDocument

Konzepte

Übersicht über die Visual Studio Tools for Office-Laufzeit

Zwischenspeichern von Daten