Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Sonstiges

Copy()

Diese Funktion erzeugt eine Kopie einer vorhandenen Dateianlage. Der Standardname für die Zieldatei ist %FileBaseName%.copy.%FileExt%.

Beispiele

Copy("test.pdf") erzeugt von einer PDF-Dateianlage eine Kopie test.copy.pdf.

Copy("test.pdf", "copy of %FileName%") erzeugt von einer PDF-Dateianlage eine Kopie copy of test.pdf.

DecryptPdf()

Diese Funktion entfernt den Kennwortschutz einer PDF-Datei, die mit einem Öffnen-Schutz oder speziellen Berechtigungen versehen ist. Der Standardname für die Zieldatei ist %FileBaseName%.decrypted.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3*(§)

Text

Passwort zur Aufhebung des Kennwortschutzes

Beispiele

DecryptPdf("test.pdf", , "<§>…<§>") erzeugt von einer PDF-Dateianlage eine entschlüsselte Kopie test.decrypted.pdf.

DrawTextPdf()

Diese Funktion fügt einer oder mehreren Seiten einer PDF-Datei ein Textfragment hinzu. Der Standardname für die Zieldatei ist %FileBaseName%.drawnText.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3*

Text

Textwert, der auf den PDF-Seite platziert wird

4*

5*

Number

X-Position (linker Rand) und Y-Position (Grundlinie) des Textes in Millimetern, gemessen vom linken oberen Seitenrand

6

Text

Name einer internen Schriftart mit den folgenden Ausprägungen:

  • Courier (Standardwert)

  • Helvetica

  • Times

Wenn ein anderer Name angegeben wird, wird versucht, die Schrift als auf dem System verfügbare TrueType-Schriftart einzubinden.

7

Number

Schriftgröße in Punkt

Standardwert: 10

8

Bool

Wahrheitswert, ob der Text fett gedruckt wird

Standardwert: FALSE

9

Text

Farbe des Textes als hexadezimaler RGB-Wert, z. B. 000000 für Schwarz oder FF00FF für Lila

Standardwert: 000000 (Schwarz) (Standardwert)

10

Number

Rotationswinkel des Textes

Standardwert: 0

11

Text

Definition der Seiten, auf denen der Text platziert wird:

  • First: nur erste Seite (Standardwert)

  • Last: nur letzte Seite

  • All: alle Seiten

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

Beispiele

DrawTextPdf("test.pdf", , "TEST", 10, 10, "Times", 12, TRUE, "FF0000", , "All") platziert auf allen Seiten einer PDF-Dateianlage in der linken oberen Ecke den Text TEST in roter Fettschrift und fügt die modifizierte Anlage als test.drawnText.pdf an.

DeleteBlankPages()

Diese Funktion löscht alle leeren Seiten aus einer mehrseitigen TIFF-Datei. Das Makro kann prinzipiell auch mit PDF-Dateien umgehen, ist aber nicht primär für native PDF-Dateien ausgelegt. Die Funktion ist spezialisiert auf eingebettete Bilddateien, um z. B. leere Rückseiten aus einem Scan-Dokument zu löschen. Der Standardname für die Zieldatei ist %FileBaseName%.pagesDeleted.%FileExt%.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Schwellwert für den Weißanteil der Seiten in Prozent, um als leer angesehen zu werden

Abschattungen durch Seitenränder und Lochungen werden implizit gefiltert und müssen nicht berücksichtigt werden.

Standardwert: 99.5

Beispiele

DeletePages("test.pdf", , "1-3") löscht aus einer PDF-Dateianlage die ersten 3 Seiten und fügt die modifizierte Anlage als test.pagesDeleted.pdf an.

DeletePages()

Diese Funktion löscht bestimmte Seiten aus einer mehrseitigen TIFF- oder PDF-Datei. Der Standardname für die Zieldatei ist FileBaseName%.pagesDeleted.%FileExt%.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3*

Text

Definition der Seiten, die gelöscht werden:

  • First: nur erste Seite (Standardwert)

  • Last: nur letzte Seite

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

Beispiele

DeletePages("test.pdf", , "1-3") löscht aus einer PDF-Dateianlage die ersten 3 Seiten und fügt die modifizierte Anlage als test.pagesDeleted.pdf an.

EncryptPDF()

Diese Funktion versieht eine PDF-Datei mit einem Kennwortschutz zum Öffnen oder zur Vergabe spezieller Berechtigungen. Der Standardname für die Zieldatei ist %FileBaseName%.encrypted.pdf.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3(§)

Text

Passwort zum Setzen eines Öffnen-Schutzes

4(§)

Text

Passwort zum Setzen spezieller Berechtigungen

5

Text

spezielle Berechtigungen, die mit dem betreffenden Passwort gesetzt werden

Die Berechtigungen sind in Form einer trennzeichenseparierten Zeichenfolge der IDs pro Berechtigung anzugeben:

  • P: Drucken

  • PF: hochauflösendes Drucken

  • C: Kopieren von Text und Grafiken

  • CA: Kopieren für die Verwendung mit Zugänglichkeitsfunktionen

  • M: Bearbeiten

  • AN: Hinzufügen von Notizen

  • FF: Ausfüllen von Formularfeldern

  • A: Zusammenstellung des Dokuments

Beispiele

EncryptPdf("test.pdf", , "<§>…<§>") versieht eine PDF-Dateianlage mit einem Öffnen-Schutz und fügt die modifizierte Anlage als test.encrypted.pdf an.

EncryptPdf("test.pdf", "%FileBaseName%.restricted.pdf", , "<§>…<§>", "P PF FF") schränkt die Berechtigungen einer PDF-Dateianlage auf Drucken und Formularfelder ein und fügt die modifizierte Anlage als test.restricted.pdf an.

Rename()

Diese Funktion benennt eine vorhandene Dateianlage um. Abweichend vom Standardverhalten eines Dateimakros wird in diesem Fall keine neue Zieldatei generiert, sondern nur der Name der Quelldatei auf den Namen geändert, der im zweiten Standardparameter definiert ist.

Der Vorgabewert für den neuen Namen ist %FileName%, d.h. der unveränderte Ursprungsname.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

optionaler Feldmakroausdruck, um den neuen Dateinamen zu generieren

Der Ausdruck muss einen Textwert mit einem gültigen Dateinamen zurückliefern. Als Grundlage dient der im zweiten Standardparameter des Dateimakros definierte Name (Standard: %FileName%), auf den im Makro über Dateivariablen (z. B. @FileName) Bezug genommen werden kann.

Beispiele

Rename("test.pdf", "%FileBaseName%.renamed.%FileExt%") benennt eine PDF-Dateianlage in test.renamed.pdf um.

Rename("test-file #1.pdf", , RegExReplace(@FileName, "[^A-Z0-9]")) benennt eine PDF-Dateianlage in testfile1.pdf um.

RotatePagesAuto()

Diese Funktion versucht die Ausrichtung der Seiten in einer TIFF-Datei automatisch zu erkennen und die Seiten in 90°-Schritten so zu drehen, dass die Seiten gerade ausgerichtet sind.

Das Makro kann prinzipiell auch mit PDF-Dateien umgehen, ist aber nicht primär für native PDF-Dateien ausgelegt. Die Funktion ist spezialisiert auf eingebettete Bilddateien, um z. B. im Hochformat gescannte Seiten korrekt als Querformat auszurichten. Die Ausrichtung wird nicht anhand der entsprechenden PDF-Seiteneigenschaft ermittelt, sondern durch eine OCR-basierte Analyse des Seiteninhalts. Der Standardname für die Zieldatei ist %FileBaseName%.rotated.%FileExt%.

Parameter

Datentyp

Beschreibung

1

Text

2

Text

3

Text

Sprache des zu verwendenden OCR-Wörterbuchs, z. B. German oder English

Bei Bedarf können kommasepariert mehrere Sprachen angegeben werden. Die jeweilige Wörterbuchdatei muss 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.

Standardwert: German

Beispiele

RotatePagesAuto("test.tif", , "German") richtet die Seiten in einer TIFF-Dateianlage aus und fügt die modifizierte Anlage als test.rotated.tif an.