AddPageHeaderFooter
Paginabewerking, annotaties
Beschrijving
Gedeelde primitieve achter AddPageHeader en AddPageFooter. Stempelt een lopende regel op de boven- of onderrand van elke pagina in het bereik, met het momenteel geselecteerde lettertype in overlaymodus, stempeltokens uitbreidend tegen elke doelpagina, en het resultaat insluitend in een Pagination-artefact met subtype Header of Footer
Syntaxis
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Parameters
| PageRange | Paginabereikexpressie, of een lege string voor elke pagina |
|---|---|
| Text | Regeltekst; de tokens die ExpandStampTokens begrijpt, worden uitgebreid tegen elke doelpagina |
| Margin | Afstand van de bovenrand (kop) of de onderrand (voettekst) tot de regel, in PDF-punten |
| Opacity | Tekstopaciteit tussen 0 en 1, waarbij 1 volledig dekkend tekent |
| Alignment | 0 lijnt links uit op de marge, 1 centreert tussen de marges, 2 lijnt rechts uit en houdt de margeafstand tot de rechterrand aan |
| IsHeader | True stempelt een kop op de bovenmarge, False stempelt een voettekst op de ondermarge |
Retourwaarden
Het aantal pagina's waarop de regel is gestempeld, of 0 wanneer geen document is geselecteerd, Text leeg is of geen pagina van het bereik kon worden geselecteerd
Opmerkingen
De regel wordt gemeten met het huidige lettertype en de huidige grootte, roep dus eerst SelectFont aan. Met IsHeader True ligt de regel op Margin van de bovenrand; met False ligt hij op Margin van de onderrand, berekend tegen de huidige paginahoogte en teksthoogte. De geselecteerde pagina wordt hersteld wanneer de aanroep terugkeert
Voorbeeld
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);