Dokumentkonverter-Objektmodell
Letzte Änderung: Montag, 8. März 2010
Gilt für: SharePoint Server 2010
Das SharePoint Foundation-Objektmodell enthält Elemente, die die Dokumentkonverter in einer angegebenen Webanwendung sowie die konvertierten Kopien in einer bestimmten Dokumentbibliothek darstellen.
Objektmodellelemente für Dokumentkonverter
Sie können die Dokumentkonverter in einer bestimmten Webanwendung programmgesteuert konfigurieren, indem Sie die folgenden Elemente des Microsoft.SharePoint.Administration-Namespaces verwenden:
DocumentConverters Gibt ein SPDocumentConverterCollection-Objekt zurück, das die zurzeit für die Webanwendung installierten Dokumenttransformatoren darstellt.
DocumentConversionsEnabled Ruft ab oder legt fest, ob Dokumenttransformatoren für die Webanwendung aktiviert sind.
DocumentConversionsLoadBalancerUrl Ruft den URI des Servers mit dem DocConvLoadBalancer-Dienst für die Webanwendung ab bzw. legt diesen fest.
DocumentConversionsSchedule Ruft den Dokumentkonverterzeitplan ab bzw. legt diesen fest.
SPDocumentConverterCollection Stellt die zurzeit für die Webanwendung installierten Dokumenttransformatoren dar.
SPDocumentConverter Stellt einen einzelnen zurzeit für die Webanwendung installierten Dokumenttransformator dar. Dieses Objekt enthält schreibgeschützte Eigenschaften, die die im Dokumentkonverterdefinitions-Schema definierten Konvertereinstellungen darstellen, z. B. den Konverternamen, Assemblynamen, "an"- und "von"-Dateinamenerweiterungen und Seiten der Konverterbenutzeroberfläche. Zudem enthält jede SPDocumentConverter-Instanz Konvertereinstellungen, die vom Administrator auf der Ebene der Webanwendung festgelegt werden. Diese für die Webanwendung spezifischen Einstellungen schließen auch Angaben dazu ein, ob der Dokumentkonverter für Endbenutzer in der Benutzeroberfläche angezeigt wird, wie viele Wiederholungen maximal zulässig sind, wie groß die Datei für Konvertierungen maximal sein darf und wann ein Timeout auftritt.
Weitere Informationen finden Sie unter Schema für die Dokumentkonverterdefinition.
Objektmodellelemente für konvertierte Dokumente
Sie können ursprüngliche Dateien und ihre konvertierten Kopien programmgesteuert identifizieren und verwenden, indem Sie die folgenden Elemente des SPFile-Objekts verwenden:
Convert Mit dieser Methode wird eine konvertierte Kopie des angegebenen Dokuments erstellt, wobei der angegebene Dokumentkonverter verwendet wird. Sie können auch benutzerdefinierte Konfigurationsinformationen angeben, die an den Dokumentkonverter übergeben werden sollen, den Dateinamen der konvertierten Kopie, die Konvertierungspriorität, die E-Mail-Adressen der zu informierenden Personen und ggf. das Einschließen der konvertierten Kopie als Anlage der Warnung. Wenn eine benutzerdefinierte Assembly an Stelle von Microsoft SharePoint Server 2010 die Nachverarbeitung der konvertierten Kopie durchführen soll, können Sie eine benutzerdefinierte Handlerassembly und Klasse angeben. Wenn Sie keinen benutzerdefinierten Handler angeben, führt SharePoint Server 2010 die übliche Nachverarbeitung der konvertierten Kopie durch.
Weitere Informationen zur benutzerdefinierten Verarbeitung finden Sie unter Benutzerdefinierte Verarbeitung von konvertierten Dokumenten.
Weitere Informationen zur standardmäßig von SharePoint Server 2010 durchgeführten Nachverarbeitung finden Sie unter Konvertierte Dokumente. Der Rückgabetyp SPFileConversionResult gibt das Ergebnis der Dokumentkonvertierung an.
GetConvertedFile Gibt die konvertierte Kopie zurück, die vom angegebenen Dokumentkonverter aus dieser Datei generiert wurde. Gibt null zurück, falls vom angegebenen Konverter keine konvertierte Kopie generiert wurde.
GetConversionState Gibt eine SPFileConversionState-Enumeration zurück, die den Status einer Konvertierung mithilfe des angegebenen Dokumentkonverters darstellt. Durch Aufruf dieser Methode können Sie bestimmen, ob eine Konvertierung mithilfe dieses Dokumentkonverters überhaupt möglich ist. Folgende Werte sind für die SPFileConversionState-Enumeration möglich:
Available Eine Konvertierung dieser Datei mit dem angegebenen Dokumentkonverter wird im System unterstützt.
Completed Eine Konvertierung dieser Datei mit dem angegebenen Dokumentkonverter wurde nicht abgeschlossen.
NotAvailable Eine Konvertierung dieser Datei mit dem angegebenen Dokumentkonverter wird im System nicht unterstützt.
Pending Eine Konvertierung dieser Datei mit dem angegebenen Dokumentkonverter wurde angefordert aber noch nicht abgeschlossen.
IsConvertedFile Gibt true zurück, falls die Datei eine konvertierte Kopie eines anderen Dokuments ist.
SPFile.ParentFile Gibt ein SPFile-Objekt zurück, das das ursprünglich zum Erstellen dieser konvertierten Kopie verwendete Dokument darstellt. Gibt null zurück, wenn die ausgewählte Datei keine konvertierte Kopie ist.
GeneratingConverterId Gibt die GUID des Dokumentkonverters zurück, der zum Erstellen dieser konvertierten Kopie verwendet wurde. Gibt null zurück, wenn die ausgewählte Datei keine konvertierte Kopie ist.
Generator Gibt den Namen des Dokumentkonverters zurück, der zum Erstellen dieser konvertierten Kopie verwendet wurde.