n2pdf unterstützt die Definition von Kopf- und Fußzeilen für die PDF-Datei. Eine Kopf- oder Fußzeile kann dabei aus einem unformatierten Text oder aus dem Inhalt eines RichText-Feldes bestehen. Die Definition einer Kopf- oder Fußzeile kann dabei auch abhängig von der jeweiligen Seite gemacht werden und umfasst den Haupttext der PDF-Datei.
Die Definition von Kopf- und Fußzeilen findet bei n2pdf über die Funktion N2PDFAddContent oder über N2PDFAddRTContent statt, indem bei diesen Funktionen die Konstanten
N2PDFVALUE_CONTENT_HEADER
für die Kopfzeile und
N2PDFVALUE_CONTENT_FOOTER
für die Fußzeile angegeben werden (siehe Parameter <ContentType> bei den Funktionen).
Auf welcher Seite die Kopf- oder Fußzeile bzw. der hinzugefügte Inhalt erscheinen soll, kann über eine weitere Konstante bestimmt werden (siehe Parameter <ContentOption> bei oben aufgeführten Funktionen). Nachfolgend die Möglichkeiten zur Definition von Kopf- und Fußzeilen bei oben genannten Funktionen:
N2PDFVALUE_HF_ALL_PAGES |
Auf allen Seiten |
N2PDFVALUE_HF_FIRST_PAGE |
Nur auf der ersten Seite |
N2PDFVALUE_HF_LAST_PAGE |
Nur auf der letzten Seite |
N2PDFVALUE_HF_EVEN_PAGES |
Auf allen geraden Seiten |
N2PDFVALUE_HF_ODD_PAGES |
Auf allen ungeraden Seiten |
N2PDFVALUE_HF_NOT_FIRST_LAST_PAGES |
Auf allen Seiten, außer auf der ersten und letzten Seite |
Kopf- und Fußzeilen auf individuellen Seiten
Neben der Benutzung der oben aufgeführten Konstanten, können Sie auch eine Kopf- oder Fußzeile (Parameter <ContentType>) gezielt für eine bestimmte Seite setzen. Übergeben Sie in diesem Fall einfach die gewünschte Seitennummer als negativen Wert in dem Parameter <ContentOption>.
Leere Kopf- und Fußzeilen
Wollen Sie den Inhalt einer Kopf- oder Fußzeile löschen, so übergeben Sie einfach einen leeren Text ("") als Wert für die Kopf- oder Fußzeile.
Beispiel:
Um z. B. gezielt unterschiedliche Kopfzeilen für die geraden und ungeraden Seiten zu setzen, sind die folgenden Aufrufe notwendig:
Call N2PDFAddContent ( JobID, N2PDFVALUE_CONTENT_HEADER,_
N2PDFVALUE_HF_EVEN_PAGES, "Even pages" )
Call N2PDFAddContent ( JobID, N2PDFVALUE_CONTENT_HEADER,_
N2PDFVALUE_HF_ODD_PAGES, "Odd pages" )
Kopfzeile für eine bestimmte Seite:
Call N2PDFAddContent ( JobID, N2PDFVALUE_CONTENT_HEADER,_
-5, "Header for page 5" )
Auf allen Seiten die gleiche Fußzeile, nur auf der Seite 5 keine Fußzeile:
Call N2PDFAddContent ( JobID, N2PDFVALUE_CONTENT_FOOTER,_
N2PDFVALUE_HF_ALL_PAGES, "All pages" )
Call N2PDFAddContent ( JobID, N2PDFVALUE_CONTENT_FOOTER, -5, "" )
|
Die Benutzung von Kopf- und Fußzeilen finden Sie in der Beispielanwendung "Header and Footer". |
|
Beachten Sie aber, dass ein Aufruf für eine bestimmte Seite nur einmal erfolgen kann. Wenn Sie die gleiche Seite, also z. B.N2PDFVALUE_HF_ODD_PAGES, mehrfach aufrufen, so wird der zuletzt gesetzte Wert genommen. Die Definition einer Kopf- oder Fußzeile für eine bestimmte Seite ersetzt den kompletten Inhalt der Kopf- oder Fußzeile und hängt ihn nicht an einen evtl. vorhandenen Text an. |
Wenn Sie als Kopf- oder Fußzeile einen unformatierten Text einfügen, dann wird dieser mit der aktuell gewählten Textvorlage eingefügt.
|
Bei Serienbriefen kann nur die Einstellung N2PDFVALUE_HF_ALL_PAGES für die Definition von Kopf- und Fußzeilen benutzt werden. Bei Serienbriefen werden die einzelnen Seiten nicht unterschieden. |
Kapitelüberschriften in Kopf- und Fußzeilen
Soll in einer Kopf- oder Fußzeile der Titel des aktuellen Kapitels, wie z. B. bei Büchern, dargestellt werden, so kann dies über die Konstante "[TOC]" (siehe Dokument "Konstanten") gemacht werden. Die Konstante "[TOC]" wird dabei mit dem aktuellen Kapiteltext, der im Haupttext über "[TOC:x]" (siehe Dokument "Inhaltsverzeichnis") definiert wurde, ersetzt.
Damit diese Konstante in Kopf- und Fußzeilen zur Verfügung steht, muss die Option N2PDFOPTION_TOC_HF_VARIABLE auf den Wert N2PDFVALUE_TRUE gesetzt werden:
Call N2PDFSetOption ( JobID, N2PDFOPTION_TOC_HF_VARIABLE, N2PDFVALUE_TRUE, "" )
|
Die Konstante "[TOC]" kann nur in Kopf- oder Fußzeilen eingesetzt werden. |
|
Es kann der Fall eintreten, dass sich durch die Einsetzung des Kapiteltextes (lange Überschrift) der Inhalt der Seite verschiebt und somit das Kapitel die Seite wechselt. In diesem Fall stimmt möglicherweise der Inhalt der "TOC"-Konstanten nicht mit der Seite der Kapitelüberschrift überein. Dies kann nur verhindert werden, wenn die Kapitelüberschriften immer auf einer neuen Seite beginnen. |
Zusätzlich besteht die Möglichkeit festzulegen, ob die Kapitelnummerierung Bestandteil der Konstante ist. Wird die Option N2PDFOPTION_TOC_HF_VARIABLE_WITH_LEVEL auf N2PDFVALUE_TRUE gesetzt, dann ist die Nummerierung enthalten (siehe Grafik), bei dem Wert N2PDFVALUE_FALSE nicht.
Kapitelnummerierung nicht übernehmen:
Call N2PDFSetOption ( JobID, N2PDFOPTION_TOC_HF_VARIABLE_WITH_LEVEL, N2PDFVALUE_FALSE, "" )
Bei einer sehr tiefen Staffelung der Kapitelnummerierung kann es gewünscht sein, das nur Kapitelüberschriften bis zur einer bestimmten Tiefe übernommen werden oder z. B. nur Hauptkapitel der ersten Ebene. Mit der Option N2PDFOPTION_TOC_HF_VARIABLE_MAX_LEVEL kann die max. Ebene bestimmt werden. Der Parameter wird dabei entsprechend der Nummerierung von "[TOC:x]" gesetzt.
Nur Kapitelüberschriften der ersten Ebene übernehmen:
Call N2PDFSetOption ( JobID, N2PDFOPTION_TOC_HF_VARIABLE_MAX_LEVEL, "1", "" )
|
Ist mehr als eine Kapitelüberschrift auf einer Seite vorhanden, so wird nur die erste Überschrift übernommen. |