Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Formatkonvertierung

ChangePdfVersion()

Diese Funktion konvertiert eine PDF-Datei in eine PDF-Datei einer anderen PDF-Version. Die Zieldatei ist das modifizierte PDF und trägt den Standardnamen %FileBaseName%.versionChanged.pdf.

Die Funktionsweise ist ähnlich wie die Funktionsweise des Makros ConvertPdfToPdfA(). Die Funktion ChangePdfVersion() ist allerdings nicht beschränkt auf PDF/A als Zielformat. Diese Funktion erlaubt im Rahmen des technisch Möglichen eine beliebige Konvertierung zwischen 2 PDF-Versionen.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

optionale Angabe der PDF-Version, in die konvertiert wird:

  • PDF_A_1a (PDF/A-1a)

  • PDF_A_1b (PDF/A-1b)

  • PDF_A_2a (PDF/A-2a)

  • PDF_A_2b (PDF/A-2b)

  • und weitere bis PDF_A_4f (PDF/A-4f)

  • PDF1_0 (PDF 1.0)

  • PDF1_1 (PDF 1.1)

  • und weitere bis PDF2_0 (PDF 2.0)

Standardwert: Wert, der unter General.FileMacroOptions.PdfALevel definiert ist

4

5

Text

optionale Angabe einer Untergrenze und/oder einer Obergrenze für eine zulässige Version der Quell-PDF-Datei

Wenn sich die Quell-PDF-Datei in dem angegebenen Bereich befindet, erfolgt keine Konvertierung. Die Werte müssen in der gleichen Syntax angegeben werden wie der Wert von Parameter 3. Die PDF-Versionen verfügen über eine interne Rangfolge. Die Reihenfolge entspricht der Aufzählung der PDF-Versionen in Parameter 3.

Alle PDF-Versionen von 1.5 bis 2.0 können beispielsweise durch die Untergrenze PDF1_5 und die Obergrenze PDF2_0 definiert werden. Einer der beiden Grenzwerte kann offen bleiben, sodass implizit alle älteren oder neueren Versionen in den Bereich eingeschlossen werden. Um z. B. alle PDF-Dateien mit einer Version, die nicht mindestens 1.5 ist, nach 2.0 zu konvertieren, muss Parameter 3 auf PDF2_0 und der Parameter 4 auf PDF1_5 gesetzt werden.

Beispiele

ChangePdfVersion("test.pdf", , "PDF2_0" , "PDF1_5") konvertiert eine PDF-Datei in die Version 2.0 unter dem Namen test.versionChanged.pdf, wenn die Ursprungsversion kleiner als 1.5 ist. Wenn die Ursprungsversion größer als 1.5 ist, wird eine unveränderte Kopie der Ursprungsdatei unter dem neuen Namen erzeugt.

ConvertAny()

Diese Funktion ist eine allgemeine Konvertierungsfunktion zur Umwandung verschiedener Quellformate in eines der Zielformate PDF oder TIFF. Der Standardname für die Zieldatei ist %FileBaseName%.%FileExt%. Die Dateiendung %FileExt% bezieht sich hierbei auf das Zielformat.

Abweichend vom Standardverhalten eines Dateimakros wird keine Zieldatei generiert, wenn die Quelldatei bereits im Zielformat vorliegt – auch nicht als Kopie der Quelldatei.

Die Umwandlung erfolgt über eine universelle Konvertierungsfunktion der GdPicture-Grafikbibliothek. Diese unterstützt folgende Quellformate:

  • Microsoft Office: DOC, DOCX, XLS, XLSX, PPT, PPTX

  • OpenDocument: ODT

  • Text: TXT, RTF

  • E-Mail: MSG, EML

  • PDF

  • HTML

  • gängige Rasterbildformate, z. B. BMP, GIF, JPEG, PNG, TIFF

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Zielformat der Konvertierung:

  • PDF (Standardwert)

  • TIFF

Beispiele

ConvertAny("test.docx", , "PDF") konvertiert eine Word-Datei in eine PDF-Datei test.pdf.

ConvertHtmlToPdf()

Diese Funktion konvertiert eine HTML-Datei in eine PDF-Datei unter Nutzung der Druckfunktion eines lokal installierten Google Chrome-Browsers. Der Standardname für die Zieldatei ist %FileBaseName%.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

optionaler Dateipfad der Anwendungsdatei chrome.exe des Browsers

Der Browser muss separat installieren werden. Unter Windows versucht das Programm standardmäßig, den Browser über den entsprechenden Registry-Eintrag eigenständig zu ermitteln.

4

Bool

Wahrheitswert, ob mögliche Hintergrundgrafiken mit gedruckt werden

Standardwert: FALSE

5

Bool

Wahrheitswert, ob der Druck im Querformat ("Landscape") erfolgt

Standardwert: FALSE

6

Text

Papierformat für den seitenweisen Ausdruck

Die folgenden Werte sind zulässig:

  • Letter

  • Legal

  • A4 (Standardwert)

7

Text

Breite der Seitenränder

Zulässig sind numerische Werte mit einer Maßeinheit, z. B. 1cm (Standardwert).

Beispiele

ConvertHtmlToPdf("test.html", , , , TRUE) konvertiert eine HTML-Datei in eine PDF-Datei test.pdf im Querformat.

ConvertImage()

Diese Funktion konvertiert eine Bilddatei in einem gängigen Rasterbildformat in ein anderes Bildformat und/oder ändert Eigenschaften wie Farbtiefe und Auflösung des Bildes.

Der Standardname für die Zieldatei ist %FileBaseName%.converted.%FileExt%. Die Dateiendung %FileExt% bezieht sich hierbei auf das Zielformat.

Die Konvertierung mehrseitiger TIFF-Dateien wird ebenfalls unterstützt, aber bei einem abweichenden Zielformat wird nur die erste Seite wieder ausgegeben.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

optionales Format der Zieldatei in Form der betreffenden Dateiendung (z. B. JPEG oder TIFF), wenn das Format geändert werden soll

4

Number

Farbtiefe (1, 8 oder 24), wenn diese geändert werden soll

Standardwert: 0 (keine Änderung)

5

Number

Auflösung in DPI, wenn diese geändert werden soll

Standardwert: 0 (keine Änderung)

6

7

Number

Absolute Bildbreite und Bildhöhe in Pixeln, wenn diese geändert werden sollen

Standardwert: 0 (keine Änderung)

Das Seitenverhältnis des Bildes bleibt grundsätzlich erhalten, d.h. nur einer der beiden Werte wird herangezogen und der andere dynamisch berechnet. Wenn einer der beiden Werte 0 ist, wird der jeweils andere Wert herangezogen, ansonsten der kleinere der beiden, und zwar in Relation zu den tatsächlichen Maßen des betreffenden Bildes.

Eine Änderung der Bildgröße bewirkt auch eine implizite Änderung der Auflösung unabhängig von dem dafür vorgesehenen Parameter 5.

8

Number

Relative Bildgröße in Prozent, wenn diese geändert werden soll, bezogen auf die Kantenlänge des Bildes

Standardwert: 0 (keine Änderung)

Dieser Parameter kann nur alternativ zu den absoluten Größenangaben in den Parametern 6 und 7 genutzt werden.

Beispiele

ConvertImage("test.tif", , "JPEG", 8, 300) konvertiert eine TIFF-Datei in eine Graustufen-JPEG-Datei test.converted.jpeg mit einer Auflösung von 300 dpi.

ConvertImageToPdf()

Diese Funktion konvertiert eine Bilddatei in einem gängigen Rasterbildformat in eine PDF-Datei. Der Standardname der Zieldatei ist %FileBaseName%.pdf.

Die Konvertierung wird nur für einseitige Bilddateien unterstützt. Für mehrseitige TIFF-Dateien muss die spezialisierte Funktion ConvertTiffToPdf() verwendet werden.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

Beispiele

ConvertImageToPdf("test.jpg") konvertiert eine JPEG-Datei in eine PDF-Datei test.pdf.

ConvertMsExcel(), ConvertMsOutlook(), ConvertMsPowerPoint(), ConvertMsWord(), ConvertPdf()

Diese Funktionen konvertieren eine Datei in einem Microsoft-Office-Format oder PDF-Format in eines von mehreren möglichen Zielformaten.

Abhängig vom Quellformat werden folgende Zielformate unterstützt:

  • MS Excel: PDF, HTML, MHTML, JPEG, PNG, TIFF

  • MS Outlook: MSG, EML, PDF, DOC, RTF, HTML, MHTML, JPEG, PNG, TIFF

  • MS PowerPoint: PDF, HTML, JPEG, PNG, TIFF

  • MS Word: PDF, RTF, TXT, HTML, MHTML, JPEG, PNG, TIFF

  • PDF: DOC, DOCX, XLSX, TXT, HTML, XML, JPEG, PNG, TIFF

Der Standardname der Zieldatei ist %FileBaseName%.%FileExt% oder %FileBaseName%.page.%FileExt%, wenn das Zielformat nur Einzelseiten unterstützt und daher eine separate Zieldatei pro Seite generiert wird. Die Dateiendung %FileExt% bezieht sich auf das Zielformat. Die Umwandlung erfolgt über universelle Konvertierungsfunktionen der Aspose-Grafikbibliothek, wobei nicht sichergestellt werden kann, dass jede individuelle Quelldatei zum gewünschten Konvertierungsergebnis führt, insbesondere bezüglich der Bewahrung des ursprünglichen Layouts.

Die Funktion ConvertMsOutlook() akzeptiert als Quelle die Dateitypen .msg und .eml und kann auch zwischen diesen beiden konvertieren. Die Funktion ConvertMsWord() kann auch dazu genutzt werden, andere einlesbare Dateitypen als nur die nativen Word-Formate zu konvertieren, z.B. .rtf, .txt, .html und .odt.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3*

Text

Format der Zieldatei (Ausprägungen gemäß obiger Quellformate)

Beispiele

ConvertMsWord("test.docx", , "PDF") konvertiert eine Word-Datei in eine PDF-Datei test.pdf.

ConvertMsWord("test.docx", , "JPEG") konvertiert eine Word-Datei in mehrere JPEG-Dateien, d.h. eine Datei pro Seite. Die Zieldateien tragen standardmäßig den gleichen Namen test.page.jpeg. Für eine eindeutige Namensgebung kann z. B. der Zieldateiname %FileBaseName%.%FileNo%.jpeg definiert werden, um die Dateien in der Form test.1.jpeg, test.2.jpeg zu nummerieren.

ConvertPdfToPdfA()

Diese Funktion konvertiert eine PDF-Datei in den PDF/A-Standard.

Die Zieldatei ist das modifizierte PDF und trägt den Standardnamen %FileBaseName%.converted.pdf. Abhängig von der PDF-Quellversion und der PDF-Zielversion müssen dabei nicht unterstützte PDF-Elemente entfernt oder in ein anderes Format umgewandelt werden, z. B. Schriften in Vektor- oder Rastergrafiken.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

optionale Angabe der PDF/A-Version, in die konvertiert wird:

  • PDF_A_1a (PDF/A-1a)

  • PDF_A_1b (PDF/A-1b)

  • PDF_A_2a (PDF/A-2a)

  • PDF_A_2b (PDF/A-2b)

  • und weitere bis PDF_A_4f (PDF/A-4f)

Standardwert: Wert, der unter General.FileMacroOptions.PdfALevel definiert ist

4

Bool

Wahrheitswert, ob eine Konvertierung erzwungen wird, wenn die Quelldatei nicht der vorgegebenen PDF/A-Version entspricht

Standardwert: false (keine Konvertierung, wenn die Datei bereits irgendeiner PDF/A-Version entspricht)

Beispiele

ConvertPdfToPdfA("test.pdf", , "PDF_A_2a") konvertiert eine PDF-Datei in eine PDF/A-Datei test.converted.pdf. Wenn die Quelldatei bereits einer PDF/A-Version entspricht, wird eine unveränderte Kopie unter dem neuen Namen erzeugt.

ConvertPdfToPdfOcr()

Diese Funktion führt für alle Bilder, die in einer PDF-Datei enthalten sind, eine OCR-Verarbeitung durch und generiert einen Volltext-Layer für diese Bilder.

Die Zieldatei ist die modifizierte PDF-Datei und trägt den Standardnamen %FileBaseName%.converted.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Seiten, die bei der OCR berücksichtigt werden:

  • First: nur erste Seite

  • Last: nur letzte Seite

  • All: alle Seiten (Standardwert)

  • freie Aufzählung von einzelnen Seitennummern oder Seitenbereichen, z. B. 1;2;3 oder 1-3

4

Text

Sprache des zu verwendenden OCR-Wörterbuchs, z .B. German (Standardwert) oder English; bei Bedarf auch kommasepariert mehrere Sprachen

Im Programmverzeichnis muss zur jeweiligen Sprache die passende Wörterbuchdatei im Programmverzeichnis verfügbar sein, z. B. deu.traineddata oder eng.traineddata. Diese beiden Dateien werden mit ausgeliefert. Weitere Wörterbuchdateien können auf Anfrage bereitgestellt werden.

5

Bool

Wahrheitswert, ob die OCR per Multithreading parallel über mehrere Seiten ausgeführt wird

Standardwert: false (sequenzielle OCR über die einzelnen Seiten)

Beispiele

ConvertPdfToPdfOcr("test.pdf", , "1-3", "German") erzeugt einen OCR-Layer auf den ersten 3 Seiten unter dem neuen Dateinamen test.converted.pdf.

ConvertPdfToTiff()

Diese Funktion konvertiert eine PDF-Datei in eine (mehrseitige) TIFF-Datei. Der Standardname der Zieldatei ist %FileBaseName%.tif.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Arbeitsmodus für PDF-Seiten, die vollständig aus einem Rasterbild bestehen:

  • RenderNew (Standardwert) und ExtractNew: Bildseiten werden in die gewünschte Auflösung/Farbtiefe konvertiert

  • RenderOriginal und ExtractOriginal: Bildseiten werden in ihrer ursprünglichen Auflösung/Farbtiefe belassen

Die Modi Render*** und Extract*** unterscheiden sich in der internen Arbeitsweise: Im Modus Render***werden PDF-Seiten direkt in das Zielformat konvertiert. Im Modus Extract*** werden zuerst die Bilddateien extrahiert und diese dann konvertiert. Bei nativen PDF-Seiten findet auch in den Modi ***Original immer eine Konvertierung in die konfigurierte Auflösung/Farbtiefe statt.

4

Number

Auflösung (dpi) der Zielseiten

Standardwert: 300

5

Number

Farbtiefe (bpp) der Zielseiten:

  • 1: Schwarz-Weiß (Standardwert)

  • 8: Graustufen

  • 24: Farbe

Beispiele

ConvertPdfToTiff("test.pdf", , "ExtractNew", 200, 8) konvertiert eine PDF-Datei in eine Graustufen-TIFF-Datei test.tif mit einer Auflösung von 200 dpi.

ConvertTiffToPdf()

Diese Funktion konvertiert eine (mehrseitige) TIFF-Datei in eine PDF-Datei.

Der Standardname der Zieldatei ist %FileBaseName%.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

Beispiele

ConvertTiffToPdf("test.tif") konvertiert eine TIFF-Datei in eine PDF-Datei test.pdf.

ConvertTiffToPdfOcr()

Diese Funktion konvertiert eine (mehrseitige) TIFF-Datei in eine PDF-Datei und generiert per OCR-Verarbeitung Volltext-Layer über die Seiteninhalte.

Der Standardname der Zieldatei ist %FileBaseName%.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Seiten, die bei der OCR berücksichtigt werden:

  • First: nur erste Seite

  • Last: nur letzte Seite

  • All: alle Seiten (Standardwert)

  • freie Aufzählung von einzelnen Seitennummern oder Seitenbereichen, z. B. 1;2;3 oder 1-3

4

Text

Sprache des zu verwendenden OCR-Wörterbuchs, z .B. German (Standardwert) oder English; bei Bedarf auch kommasepariert mehrere Sprachen

Im Programmverzeichnis muss zur jeweiligen Sprache die passende Wörterbuchdatei im Programmverzeichnis verfügbar sein, z. B. deu.traineddata oder eng.traineddata. Diese beiden Dateien werden mit ausgeliefert. Weitere Wörterbuchdateien können auf Anfrage bereitgestellt werden.

5

Bool

Wahrheitswert, ob die OCR per Multithreading parallel über mehrere Seiten ausgeführt wird

Standardwert: false (sequenzielle OCR über die einzelnen Seiten)

Beispiele

ConvertTiffToPdfOcr("test.tif", , "First", "German") konvertiert eine TIFF-Datei in eine PDF-Datei test.pdf und erzeugt auf der ersten Seite der PDF-Datei einen OCR-Layer.

ConvertToPdf()

Diese Funktion ist eine allgemeine Konvertierungsfunktion zur Umwandlung verschiedener Quellformate in das Zielformat PDF. Der Standardname der Zieldatei ist %FileBaseName%.pdf.

Dies ist eine übergeordnete Sammelfunktion für alle anderen Funktionen, die zur PDF-Umwandlung dienen und auf ein bestimmtes Quellformat spezialisiert sind.

Damit bei dem Umgang mit mehreren Quellformaten nicht für jedes Format einen separaten Funktionsaufruf konfiguriert werden muss, leitet die Funktion ConvertToPdf() den Aufruf an die Funktion weiter, die zu dem Format passt. Die spezialisierten Funktionen werden dabei bevorzugt verwendet. Erst wenn keine Funktion vorhanden ist, die zum Quellformat passt, wird die universelle Funktion ConvertAny() aufgerufen.

Hinweis

Die Funktion ConvertToPdf() ermöglicht keine Übergabe spezifischer Parameter. Der Aufruf der Konvertierungsfunktionen erfolgt hier nur mit Standardwerten. Daher ist für bestimmte Quellformate dennoch ein direkter Aufruf der betreffenden Funktion erforderlich.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

Beispiele

ConvertToPdf("test.docx") konvertiert eine Word-Datei in eine PDF-Datei test.pdf.

TransformXml()

Diese Funktion führt für eine XML-Quelldatei mithilfe einer Stylesheet-Datei eine XSL-Transformation aus. Der Standardname für die Zieldatei ist %FileBaseName%.%FileExt%. Die Dateiendung %FileExt% entspricht dem konfigurierten Zielformat.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3*

Text

vollständiger Dateipfad der Stylesheet-Datei im XSLT-Format

4

Text

Zieldateiformat, das durch die Transformation erstellt wurde, in Form der Dateiendung

Standardwert: html

5

Text

XSL-Prozessor, der verwendet wird

Die folgenden XSL-Prozessoren sind verfügbar:

  • Internal: .NET-interner Prozessor (unterstützt nur XSLT 1.0)

  • Saxon: externer Saxon-Prozessor (unterstützt auch Basisfunktionen von XSLT 3.0) (Standardwert)

Beispiele

TransformXml("test.xml", , "C:\\transform.xslt", "html") konvertiert eine XML-Datei in eine HTML-Datei test.html unter Nutzung der Stylesheet-Datei transform.xslt.