SetPageHeaderFooterVariant

Seitenlayout, Seitennummerierung, HTML-Text

Beschreibung

Erstellt oder ersetzt eine Variante in einem benannten wiederverwendbaren Satz für laufende Kopf- und Fußzeilen

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);

Parameter

SetName	Groß-/kleinschreibungsunabhängiger Name, den Varianten gemeinsam haben, die zu einem Vorlagensatz gehören
VariantName	`default`, `first`, `odd` oder `even`, ohne Beachtung der Groß-/Kleinschreibung verglichen
Text	Text- oder HTML-Vorlage, die für jede ausgewählte Seite separat erweitert wird; ein leerer Wert erstellt eine ausdrücklich leere Variante, die den Fallback unterdrückt
Margin	Nicht negativer Abstand vom betreffenden Seitenrand
Height	Höhe des Inhaltsfelds oder 0, um die Klartextzeile oder den HTML-Inhalt automatisch zu vermessen
Opacity	Wert von 0 für transparent bis 1 für deckend
Alignment	0 für links, 1 für zentriert oder 2 für rechts
IsHeader	1 für eine Kopfzeile oder 0 für eine Fußzeile
RichText	1, um `Text` als HTML zu rendern, oder 0, um die derzeit ausgewählte Schriftart und den Painter-Zustand zu verwenden

Rückgabewerte

Gibt 1 zurück, wenn die Variante gespeichert wurde, oder 0, wenn ein Name, eine Variante, ein numerischer Wert, eine Ausrichtung oder ein Flag ungültig ist

Anmerkungen

Ein späterer Aufruf mit demselben Satznamen, Variantennamen und derselben Kopf- oder Fußzeilenrolle ersetzt die vorhandene Definition

Vorlagen unterstützen dieselben kaufmännischen-und- und <%name%>-Felder wie AddPageHeader, einschließlich benutzerdefinierter Variablen, die durch OnCalcVariable aufgelöst werden

Definitionen gehören zur Instanz TPDFlib und können auf mehrere Dokumente angewendet werden

Beispiel

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);