N2PDFAddContent ( <JobID>, <ContentType>, <ContentOption>, <Content>) -> <ErrorCode>
Beschreibung
Mit dieser Funktion können Sie der PDF-Datei einen unformatierten Text (Plain text) hinzufügen. Der Text wird an der aktuellen Position innerhalb der PDF-Datei eingefügt. Auf diesen Text werden die Formatierungen angewendet, die aktuell über N2PDFSetOption gewählt sind. Bei dem Aufruf der Funktion kann zusätzlich noch gewählt werden, zu welchem Bereich der PDF-Datei (Kopf-, Fußzeile oder Haupttext) der Inhalt hinzugefügt werden soll.
Deklaration für Lotus Script
Declare Function N2PDFAddContentW Lib LibName ( ByVal JobID As Long,_
ByVal ContentType As Long, ByVal ContentOption As Long,_
ByVal Content As Unicode String ) As Long
Parameter
<JobID> (LONG)
Die Nummer, die beim Aufruf von N2PDFInit zurückgeliefert wird und die die PDF-Datei im Hauptspeicher referenziert. Über diese ID steuern Sie, welche PDF-Datei Sie mit der Funktion ansprechen wollen.
<ContentType> (LONG)
Über diesen Parameter bestimmen Sie, zu welchem Bereich der PDF-Datei der Inhalt hinzugefügt (angehängt) werden soll. Dabei sind die folgenden Parameter möglich:
N2PDFVALUE_CONTENT_BODY |
Hängt den Inhalt dem Hauptbereich der PDF-Datei an. |
N2PDFVALUE_CONTENT_HEADER |
Hängt den Inhalt in die Kopfzeile der PDF-Datei an. |
N2PDFVALUE_CONTENT_FOOTER |
Hängt den Inhalt in die Fußzeile der PDF-Datei an. |
Je nach <ContentType> sind weitere Angaben über den Parameter <ContentOption> zu machen.
<ContentOption> (LONG)
Über diesen Parameter bestimmen Sie weitere Einstellungen für das Anhängen des Inhalts an die PDF-Datei. Je nach gewähltem Bereich <ContentType> können Sie hier unterschiedliche Parameter verwenden. Die Verwendung von mehreren Parametern gleichzeitig wird durch Addition der einzelnen Werte erreicht. Eine Zuordnung aller Werte zu dem jeweiligen Bereich der PDF-Datei können Sie der nachfolgenden Tabelle entnehmen:
N2PDFVALUE_CONTENT_BODY
|
|
N2PDFVALUE_PAGEBREAK_AFTER |
Fügt einen Seitenumbruch nach dem Inhalt ein. |
N2PDFVALUE_PAGEBREAK_BEFORE |
Fügt einen Seitenumbruch vor dem Inhalt ein |
N2PDFVALUE_CRLF_AFTER |
Fügt einen Zeilenumbruch nach dem Inhalt ein. |
N2PDFVALUE_CRLF_BEFORE |
Fügt einen Zeilenumbruch vor dem Inhalt ein. |
N2PDFVALUE_CONTENT_HEADER N2PDFVALUE_CONTENT_FOOTER
|
|
N2PDFVALUE_HF_ALL_PAGES |
Fügt den Inhalt als Kopf- oder Fußzeile für alle Seiten ein. |
N2PDFVALUE_HF_FIRST_PAGE |
Fügt den Inhalt als Kopf- oder Fußzeile nur für die erste Seite ein. |
N2PDFVALUE_HF_LAST_PAGE |
Fügt den Inhalt als Kopf- oder Fußzeile nur für die letzte Seite ein. |
N2PDFVALUE_HF_EVEN_PAGES |
Fügt den Inhalt als Kopf- oder Fußzeile für alle gerade Seiten ein. |
N2PDFVALUE_HF_ODD_PAGES |
Fügt den Inhalt als Kopf- oder Fußzeile für alle ungeraden Seiten ein. |
N2PDFVALUE_HF_NOT_FIRST_LAST_PAGES |
Fügt den Inhalt als Kopf- oder Fußzeile für alle Seiten ein, außer der ersten und der letzten Seite. |
|
Hinweise für Kopf- und Fußzeilen: Es wird immer der gesamte Inhalt ersetzt, d. h. evtl. vorhandener Inhalt wird gelöscht und durch den neuen Inhalt ersetzt. Wollen Sie unterschiedliche Kopf- und Fußzeilen für verschiedene Seiten definieren, so müssen Sie einfach die Funktion mehrfach aufrufen und bei <ContentOption> unterschiedliche Werte angeben. |
<Content> (UNICODE STRING)
Mit diesem Parameter übergeben Sie den Inhalt, welcher der PDF-Datei hinzugefügt werden soll.
Rückgabe
<ErrorCode> (LONG)
Nummer des Fehlers, der bei der Ausführung der Funktion aufgetreten ist (siehe „Fehlernummern ").