AddPageHeaderFooter
Seitenmanipulation, Annotationen
Beschreibung
Gemeinsames Grundprimitiv hinter AddPageHeader und AddPageFooter. Stempelt eine laufende Zeile an die obere oder untere Kante jeder Seite des Bereichs, verwendet dabei die aktuell gewählte Schrift im Overlay-Modus, expandiert Stempel-Token gegen jede Zielseite und schließt das Ergebnis in ein Paginierungs-Artefakt mit dem Subtyp Header oder Footer ein
Syntax
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Parameter
| PageRange | Seitenbereichs-Ausdruck oder ein leerer String für jede Seite |
|---|---|
| Text | Zeilentext; die von ExpandStampTokens verstandenen Token expandieren gegen jede Zielseite |
| Margin | Abstand von der Oberkante (Kopfzeile) oder Unterkante (Fußzeile) zur Zeile, in PDF-Punkten |
| Opacity | Textdeckkraft zwischen 0 und 1, wobei 1 vollständig deckend zeichnet |
| Alignment | 0 richtet am Rand linksbündig aus, 1 zentriert zwischen den Rändern, 2 richtet rechtsbündig aus und hält den Randabstand zur rechten Kante ein |
| IsHeader | True stempelt eine Kopfzeile am oberen Rand, False stempelt eine Fußzeile am unteren Rand |
Rückgabewerte
Die Anzahl der Seiten, auf denen die Zeile gestempelt wurde, oder 0, wenn kein Dokument ausgewählt ist, Text leer ist oder keine Seite des Bereichs ausgewählt werden konnte
Hinweise
Die Zeile wird mit der aktuellen Schrift und Größe vermessen, rufen Sie daher zuerst SelectFont auf. Bei IsHeader True sitzt die Zeile im Abstand Margin von der Oberkante; bei False sitzt sie im Abstand Margin von der Unterkante, berechnet gegen die aktuelle Seitenhöhe und Texthöhe. Die ausgewählte Seite wird bei der Rückkehr des Aufrufs wiederhergestellt
Beispiel
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);