AddPageHeader
Manipulation de pages, annotations
Description
Appose une ligne d’en-tête courant sur une ou plusieurs pages du document sélectionné. Le texte est dessiné en mode surimpression avec la police actuellement sélectionnée, les jetons d’apposition tels que <%PageNo%> sont expansés pour chaque page cible avant la mesure de la ligne, et la ligne apposée est enfermée dans un artefact Pagination de sous-type Header, de sorte que les lecteurs de PDF balisé la traitent comme du mobilier de page et non comme du contenu répété
Syntaxe
Delphi
Function TPDFlib.AddPageHeader(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer): Integer;Paramètres
| PageRange | Expression de plage de pages, ou chaîne vide pour toutes les pages |
|---|---|
| Text | Texte d’en-tête ; les jetons reconnus par ExpandStampTokens s’expandent pour chaque page cible |
| Margin | Distance du bord supérieur de la page à la ligne d’en-tête, en points PDF |
| Opacity | Opacité du texte entre 0 et 1, où 1 dessine entièrement opaque |
| Alignment | 0 aligne à gauche à la marge, 1 centre entre les marges, 2 aligne à droite en conservant la distance de marge depuis le bord droit |
Valeurs de retour
Le nombre de pages sur lesquelles l’en-tête a été apposé, 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 ; le contenu déjà présent sur la page reste visible sous la surimpression. La page sélectionnée est restaurée au retour de l’appel
Pour les rôles d’en-tête première page, page impaire et page paire avec prise en charge du contenu HTML, voir ApplyPageHeaderFooterSet
Exemple
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
28, 1, 1);