AddPageHeader
Seitenmanipulation, Annotationen
Beschreibung
Stempelt eine laufende Kopfzeile auf eine oder mehrere Seiten des ausgewählten Dokuments. Der Text wird im Overlay-Modus mit der aktuell gewählten Schrift gezeichnet, Stempel-Token wie <%PageNo%> werden vor der Vermessung der Zeile gegen jede Zielseite expandiert, und die gestempelte Zeile wird in ein Paginierungs-Artefakt mit dem Subtyp Header eingeschlossen, sodass getaggte PDF-Betrachter sie als Seitenschmuck behandeln statt als wiederholten Inhalt
Syntax
Delphi
Function TPDFlib.AddPageHeader(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer): Integer;Parameter
| PageRange | Seitenbereichs-Ausdruck oder ein leerer String für jede Seite |
|---|---|
| Text | Kopfzeilentext; die von ExpandStampTokens verstandenen Token expandieren gegen jede Zielseite |
| Margin | Abstand von der Oberkante der Seite zur Kopfzeile, 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 |
Rückgabewerte
Die Anzahl der Seiten, auf denen die Kopfzeile 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; Inhalt, der bereits auf der Seite liegt, bleibt unter dem Overlay sichtbar. Die ausgewählte Seite wird bei der Rückkehr des Aufrufs wiederhergestellt
Für Kopfzeilenrollen nach Erst-, ungerader und gerader Seite mit HTML-Inhaltsunterstützung siehe ApplyPageHeaderFooterSet
Beispiel
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
28, 1, 1);