AddPageHeaderFooter
Przetwarzanie stron, Adnotacje
Opis
Współdzielony element bazowy metod AddPageHeader i AddPageFooter. Umieszcza bieżący wiersz przy górnej lub dolnej krawędzi każdej strony w zakresie, używając aktualnie wybranej czcionki w trybie nakładki, rozwijając tokeny stempla względem każdej strony docelowej i ujmując wynik w artefakt Pagination z podtypem Header lub Footer
Składnia
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Parametry
| PageRange | Wyrażenie zakresu stron albo pusty ciąg dla wszystkich stron |
|---|---|
| Text | Tekst wiersza; tokeny rozpoznawane przez ExpandStampTokens są rozwijane względem każdej strony docelowej |
| Margin | Odległość od górnej krawędzi (nagłówek) lub dolnej krawędzi (stopka) do wiersza, w punktach PDF |
| Opacity | Krycie tekstu od 0 do 1, gdzie 1 oznacza pełne krycie |
| Alignment | 0 wyrównuje do lewej przy marginesie, 1 wyśrodkowuje między marginesami, 2 wyrównuje do prawej i zachowuje odległość marginesu od prawej krawędzi |
| IsHeader | True umieszcza nagłówek przy górnym marginesie, False umieszcza stopkę przy dolnym marginesie |
Wartości zwracane
Liczba stron, na których umieszczono wiersz, albo 0, gdy nie wybrano dokumentu, Text jest pusty lub nie udało się wybrać żadnej strony z zakresu
Uwagi
Wiersz jest mierzony przy użyciu bieżącej czcionki i rozmiaru, dlatego najpierw wywołaj SelectFont. Gdy IsHeader ma wartość True, wiersz znajduje się w odległości Margin od górnej krawędzi; gdy False, w odległości Margin od dolnej krawędzi, obliczonej na podstawie bieżącej wysokości strony i tekstu. Po powrocie z wywołania wybrana strona zostaje przywrócona
Przykład
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);