AddPageHeaderFooter

Manipulace se stránkami, anotace

Popis

Sdílený primitiv za AddPageHeader a AddPageFooter. Razítku běžící řádku na horní nebo spodní hraně každé stránky v rozsahu, používá aktuálně vybraný font v režimu překryvu, rozvíjí razítkové tokeny proti každé cílové stránce a uzavírá výsledek do artefaktu paginace s podtypem Header nebo Footer

Syntaxe

Delphi

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

Parametry

PageRangeVýraz rozsahu stránek, nebo prázdný řetězec pro všechny stránky
TextText řádku; tokeny, kterým rozumí ExpandStampTokens, se rozvinou proti každé cílové stránce
MarginVzdálenost od horního okraje (záhlaví) nebo spodního okraje (zápatí) k řádku, v bodech PDF
OpacityPrůhlednost textu mezi 0 a 1, kde 1 kreslí zcela neprůhledně
Alignment0 zarovná doleva na okraji, 1 vycentruje mezi okraji, 2 zarovná doprava a zachová vzdálenost okraje od pravého okraje
IsHeaderTrue razítkuje záhlaví na horním okraji, False razítkuje zápatí na spodním okraji

Návratové hodnoty

Počet stránek, na nichž byla razítkována řádku, nebo 0, když není vybrán žádný dokument, Text je prázdný, nebo žádnou stránku rozsahu nešlo vybrat

Poznámky

Řádek se měří aktuálním fontem a velikostí, takže nejprve volejte SelectFont. S IsHeader True leží řádek ve vzdálenosti Margin od horního okraje; s False leží ve vzdálenosti Margin od spodního okraje, počítáno vůči aktuální výšce stránky a výšce textu. Vybraná stránka se obnoví, když volání skončí

Příklad

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