AddPageHeaderFooter

Manipolazione delle pagine, annotazioni

Descrizione

Primitiva condivisa alla base di AddPageHeader e AddPageFooter. Timbra una riga ricorrente sul bordo superiore o inferiore di ogni pagina dell'intervallo, usando il font attualmente selezionato in modalità overlay, espandendo i token di timbratura rispetto a ciascuna pagina di destinazione e racchiudendo il risultato in un artifact Pagination con sottotipo Header o Footer

Sintassi

Delphi

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

Parametri

PageRangeEspressione di intervallo di pagine, oppure stringa vuota per tutte le pagine
TextTesto della riga; i token riconosciuti da ExpandStampTokens si espandono rispetto a ciascuna pagina di destinazione
MarginDistanza dal bordo superiore (intestazione) o inferiore (piè di pagina) alla riga, in punti PDF
OpacityOpacità del testo tra 0 e 1, dove 1 disegna completamente opaco
Alignment0 allinea a sinistra al margine, 1 centra tra i margini, 2 allinea a destra mantenendo la distanza di margine dal bordo destro
IsHeaderTrue timbra un'intestazione al margine superiore, False timbra un piè di pagina al margine inferiore

Valori restituiti

Il numero di pagine su cui è stata timbrata la riga, oppure 0 quando nessun documento è selezionato, Text è vuota o nessuna pagina dell'intervallo può essere selezionata

Osservazioni

La riga viene misurata con il font e la dimensione correnti, quindi chiamare prima SelectFont. Con IsHeader True la riga si trova a Margin dal bordo superiore; con False a Margin dal bordo inferiore, calcolato rispetto all'altezza corrente della pagina e del testo. La pagina selezionata viene ripristinata al ritorno della chiamata

Esempio

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