"Word Automation Services"-Objektmodell
Letzte Änderung: Donnerstag, 1. April 2010
Gilt für: SharePoint Server 2010
In diesem Thema erhalten Sie Informationen zu den primären Objekten, die für die Entwicklung mit Word-Automatisierungsdienste verwendet werden.
Übersicht
Das Programmiermodell für Word-Automatisierungsdienste stellt ein serverseitiges Objektmodell bereit, das von Anwendungen verwendet wird, um Konvertierungen asynchron anzufordern. Zu diesem Zweck werden die folgenden Aktionen ausgeführt:
Festlegung der Dienstanwendung, die die Konvertierung ausführt
Festlegung der erforderlichen und optionalen Eigenschaften für die Konvertierungsgruppe
Festlegung von einer oder mehreren zu konvertierenden Dateien
Übermittlung der Konvertierung an die Dokumentwarteschlange
Nachdem die Anwendung eine Konvertierungsanforderung übermittelt hat, verwendet der Dienst automatisch eine FIFO-Warteschlange (First in, First out), um diese Konvertierungen auf der Grundlage des für diese Dienstanwendung festgelegten Zeitplans zu starten. Jede Konvertierungsanforderung legt zudem eine GUID fest, die Sie zum Abfragen von Statusinformationen über diese Konvertierungsanforderung verwenden können.
Erstellen eines Konvertierungsauftrags
Um Dateien unter Verwendung von Word-Automatisierungsdienste zu konvertieren, verwendet das Objektmodell das ConversionJob-Objekt, um einen Satz von Konvertierungen als einzelne Einheit nachzuverfolgen. Beispielsweise sind für die Konvertierung von 15 Dateien in das PDF-Format und von 30 Dateien in das XPS-Format zwei ConversionJob-Objekte erforderlich. Eins für jede Konvertierung mit den gleichen Eigenschaften.
Um das ConversionJob-Objekt zu initialisieren, erfordert der Code einen einzelnen Parameter, der den Namen, die ID oder den der Dienstanwendung entsprechenden Dienstanwendungsproxy festzulegen. Im allgemeinen ist der Name der Dienstanwendung, der bei ihrer Erstellung festgelegt wird, am einfachsten zu verwenden.
Nachdem ein ConversionJob-Objekt erstellt wurde, wird ihm eine eindeutige ID zugewiesen. Das ConversionJob-Objekt macht diese ID über seine JobId-Eigenschaft verfügbar. Auf diese Weise kann der Konvertierungsauftrag nach seiner Übermittlung abgefragt werden.
Konfigurieren der Einstellungen
Nachdem Sie ein ConversionJob-Objekt erstellt haben, können Sie mehrere Einstellungen für den ConversionJob verwenden, um festzulegen, wie die Konvertierung ausgeführt werden soll.
Die wichtigste dieser Einstellungen ist die UserToken-Eigenschaft, die die Benutzeranmeldeinformationen festlegt, die für den Zugriff auf die zu konvertierenden Dokumente und für das Zurückschreiben der Dokumente in die SharePoint Server 2010-Liste verwendet werden. Standardmäßig wird der anonyme Zugriff verwendet. Als bewährte Methode sollten Sie die Anmeldeinformationen des Benutzers zuweisen, der den Konvertierungsauftrag an die UserToken -Eigenschaft übermittelt, um sicherzustellen, dass die Dokumente erfolgreich konvertiert werden.
Zusätzlich zu der UserToken-Eigenschaft enthält die Settings-Eigenschaft eine Sammlung weiterer Konvertierungseinstellungen. Diese Sammlung enthält Einstellungen, die Folgendes festlegen:
Ob Felder automatisch aktualisiert werden sollen oder nicht
Ob Ausgabedateien automatisch vorhandene Dateien überschreiben sollen
Das Ausgabedateiformat
Überwachen des Fortschritts
Nachdem ein Auftrag übermittelt wurde, wird er asynchron in der Reihenfolge verarbeitet, in der er der Dokumentwarteschlange hinzugefügt wurde. Sie können Konvertierungsaufträge jedoch jederzeit unter Verwendung der im ConversionJobStatus-Objekt verfügbaren Methoden überwachen:
Die GetAllJobs(String, Nullable<Guid>)-Methode gibt die IDs für alle Konvertierungsaufträge für eine spezifische Instanz des Diensts zurück (wieder gefiltert nach Instanzname, ID oder Proxy), die dann optional nach den von einem bestimmten Benutzer übermittelten Aufträgen gefiltert werden können.
Die GetAllActiveJobs(String, Nullable<Guid>)-Methode gibt die IDs für alle Konvertierungsaufträge für eine spezifische Instanz des Diensts zurück, für die noch mindestens ein Element verarbeitet werden muss (wieder gefiltert nach Instanzname, ID oder Proxy), die dann optional nach den von einem bestimmten Benutzer übermittelten Aufträgen gefiltert werden können.
Auf der Ebene des Konvertierungsauftrags können Sie das ConversionJobStatus-Objekt für einen bestimmten Auftrag erstellen, indem Sie seine ID verwenden (abgerufen von den obigen Methoden, oder Sie kennen die ID von der Auftragserstellung). Dieses Objekt enthält eine Liste aller Konvertierungselemente, die erfolgreich waren, bei denen Fehler aufgetreten sind, oder die noch nicht verarbeitet wurden.