AddPageHeaderFooter

Sidebehandling, anmærkninger

Beskrivelse

Fælles primitiv bag AddPageHeader og AddPageFooter. Stempler en løbende linje ved øverste eller nederste kant af hver side i intervallet, bruger den aktuelt valgte skrifttype i overlay-tilstand, udvider stempeltokens mod hver målside og indkapsler resultatet i et Pagination-artefakt med undertypen Header eller Footer

Syntaks

Delphi

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

Parametre

PageRange Sideintervaludtryk eller en tom streng for alle sider
Text Linjetekst; de tokens, som ExpandStampTokens forstår, udvides mod hver målside
Margin Afstand fra øverste kant (sidehoved) eller nederste kant (sidefod) til linjen, i PDF-punkter
Opacity Tekstopacitet mellem 0 og 1, hvor 1 tegner helt uigennemsigtigt
Alignment 0 venstrejusterer ved margenen, 1 centrerer mellem margenerne, 2 højrejusterer og bevarer margenafstanden fra højre kant
IsHeader True stempler et sidehoved ved den øverste margen, False stempler en sidefod ved den nederste margen

Returværdier

Antallet af sider, hvorpå linjen blev stemplet, eller 0, når intet dokument er valgt, Text er tom, eller ingen side i intervallet kunne vælges

Bemærkninger

Linjen måles med den aktuelle skrifttype og størrelse, så kald SelectFont først. Med IsHeader True ligger linjen ved Margin fra øverste kant; med False ligger den ved Margin fra nederste kant, beregnet ud fra den aktuelle sidehøjde og teksthøjde. Den valgte side gendannes, når kaldet returnerer

Eksempel

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