convertToPdf
Versionshinweise | 17.1.21, 20.1.06 |
---|
Code
IPdfResult convertToPdf(String sourceFileName, String targetPdfFileName); |
Beschreibung
Konvertiert die angegebene Quelldatei in das PDF-Format und speichert diese unter dem angegebenen Zieldateinamen.
Parameter
- sourceFileName
Name der Quelldatei, die nach PDF konvertiert werden soll (mit vollständiger Pfadangabe).
Folgende Dateitypen werden bei der Konvertierung unterstützt:Word: doc, docx, docm, docb, dot, dotx, dotm, rtf
OpenOffice: odt, ott
Text: txt, xml, html, mhtml
Excel: xls, xlsx, xlsm, xlsb, xlt, xltm, xltx
- Powerpoint: ppt, pptx, pot, potx, pps, ppsx, ppa, ppam, pptm, ppsm, potm (seit 22.1)
- Visio: vsd, vsdx, vsdm, vsx, vst, vss, vtx, vdx, vstx, vstm, vssx, vssm, vdw (ab 20.1)
Sonstige: svg, xps, epub
- targetPdfFileName
Optionaler Parameter: Gibt an, unter welchem Namen die konvertierte PDF-Datei abgespeichert werden soll (mit vollständiger Pfadangabe).
Unabhängig von der Dateiendung des targetPdfFileName liegt die konvertierte Datei immer im PDF-Format vor!
Wird der Parameter nicht verwendet, so wird die konvertierte PDF im gleichen Pfad (mit Dateiendung 'pdf') gespeichert.
Rückgabe
Ergebnis der PDF-Konvertierung.
Folgende Methoden stehen in dem Rückgabeobjekt IPdfResult zur Verfügung:
boolean isSuccessful()
War die PDF-Konvertierung erfolgreich?String getFileName()
Name der generierten PDF-Datei (mit vollständiger Pfadangabe). Der übergebene Dateiname (targetPdfFileName) wird auf Gültigkeit geprüft und falls notwendig korrigiert. Ungültige Zeichen werden durch das Zeichen _ ersetzt und die Dateiendung pdf wird sofern notwendig angehängt.String getErrorCode()
Liefert den Fehlercode, falls die PDF-Konvertierung nicht erfolgreich war. Mit Hilfe der Fehlercodes können individuelle Ausgaben im Scripting hinterlegt werden.Folgende Fehlercodes können bei dieser Aktion auftreten:PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE
Dieser Dateityp wird bei der PDF-Konvertierung nicht unterstützt.PdfConstants.PDF_ERRORCODE_FILENOTFOUND
Die übergebene Quelldatei ist nicht vorhanden.PdfConstants.PDF_ERRORCODE_GENERAL
Ein allgemeiner Fehler ist bei der PDF-Konvertierung aufgetreten.
Beispiele
|