SetPageHeaderFooterVariant

Sidlayout, Sidbrytning, HTML-text

Beskrivning

Skapar eller ersätter en variant i en namngiven återanvändbar löpande sidhuvuds- och sidfotsuppsättning

Syntax

Delphi

Function TPDFlib.SetPageHeaderFooterVariant(Const SetName, VariantName,
  Text: WideString; Margin, Height, Opacity: Double; Alignment,
  IsHeader, RichText: Integer): Integer;

ActiveX

Function PDFlib::SetPageHeaderFooterVariant(SetName As String,
  VariantName As String, Text As String, Margin As Double,
  Height As Double, Opacity As Double, Alignment As Long,
  IsHeader As Long, RichText As Long) As Long

DLL

int DLSetPageHeaderFooterVariant(int InstanceID, const wchar_t* SetName,
  const wchar_t* VariantName, const wchar_t* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);
int DLSetPageHeaderFooterVariantA(int InstanceID, const char* SetName,
  const char* VariantName, const char* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);

Parametrar

SetName	Skiftlägesokänsligt namn delat av varianter som hör till en och samma malluppsättning
VariantName	`default`, `first`, `odd` eller `even`, matchat skiftlägesokänsligt
Text	Text- eller HTML-mall som expanderas separat för varje vald sida; ett tomt värde skapar en explicit tom variant som undertrycker fallback
Margin	Icke-negativt avstånd från relevant sidkant
Height	Content box-höjd, eller 0 för att mäta raden med vanlig text eller HTML-innehållet automatiskt
Opacity	Värde från 0 för transparent till 1 för opak
Alignment	0 for left, 1 for centre, or 2 for right
IsHeader	1 for a header or 0 for a footer
RichText	1 för att rendera `Text` som HTML, eller 0 för att använda det för tillfället valda typsnittet och painter-tillståndet

Returvärden

Returnerar 1 när varianten sparades, eller 0 när ett namn, variant, numeriskt värde, justering eller flagga är ogiltigt

Anmärkningar

Ett senare anrop med samma uppsättningsnamn, variantnamn och sidhuvuds- eller sidfotsroll ersätter den befintliga definitionen

Mallarna har samma ampersand- och <%name%>-fält som AddPageHeader, inklusive anpassade variabler som löses av OnCalcVariable. Definitionerna hör till en

TPDFlib-instans och kan tillämpas på mer än ett dokument

Exempel

PDF.SetPageHeaderFooterVariant('manual', 'first', '', 36, 0, 1, 0, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'odd', 'Chapter — <%PageNo%>', 36, 0, 1, 2, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'even', '<%PageNo%> — Chapter', 36, 0, 1, 0, 1, 0);