AddPageHeaderFooter

Manipulation de pages, annotations

Description

Primitive partagée derrière AddPageHeader et AddPageFooter. Appose une ligne courante au bord supérieur ou inférieur de chaque page de la plage, avec la police actuellement sélectionnée en mode surimpression, en expansant les jetons d’apposition pour chaque page cible et en enfermant le résultat dans un artefact Pagination de sous-type Header ou Footer

Syntaxe

Delphi

Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
  Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;

Paramètres

PageRangeExpression de plage de pages, ou chaîne vide pour toutes les pages
TextTexte de la ligne ; les jetons reconnus par ExpandStampTokens s’expandent pour chaque page cible
MarginDistance du bord supérieur (en-tête) ou du bord inférieur (pied de page) à la ligne, en points PDF
OpacityOpacité du texte entre 0 et 1, où 1 dessine entièrement opaque
Alignment0 aligne à gauche à la marge, 1 centre entre les marges, 2 aligne à droite en conservant la distance de marge depuis le bord droit
IsHeaderTrue appose un en-tête à la marge supérieure, False appose un pied de page à la marge inférieure

Valeurs de retour

Le nombre de pages sur lesquelles la ligne a été apposée, ou 0 lorsqu’aucun document n’est sélectionné, que Text est vide, ou qu’aucune page de la plage n’a pu être sélectionnée

Remarques

La ligne est mesurée avec la police et la taille courantes, donc appelez d’abord SelectFont. Avec IsHeader à True, la ligne se situe à Margin du bord supérieur ; avec False, à Margin du bord inférieur, calculé par rapport à la hauteur de page et à la hauteur du texte courantes. La page sélectionnée est restaurée au retour de l’appel

Exemple

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);