ApplyPageHeaderFooterSet

Seitenlayout, Seitennummerierung, HTML-Text

Beschreibung

Wendet eine benannte Kopf- und Fußzeilengruppe mit Auswahl nach erster Seite und physischer Seitenparität auf einen Seitenbereich an

Syntax

Delphi

Function TPDFlib.ApplyPageHeaderFooterSet(Const SetName,
  PageRange: WideString): Integer;

ActiveX

Function PDFlib::ApplyPageHeaderFooterSet(SetName As String,
  PageRange As String) As Long

DLL

int DLApplyPageHeaderFooterSet(int InstanceID, const wchar_t* SetName,
  const wchar_t* PageRange);
int DLApplyPageHeaderFooterSetA(int InstanceID, const char* SetName,
  const char* PageRange);

Parameter

SetName	Name ohne Beachtung der Groß-/Kleinschreibung, der zuvor mit SetPageHeaderFooterVariant registriert wurde
PageRange	Seitenbereichsausdruck oder eine leere Zeichenfolge für jede Seite

Rückgabewerte

Gibt die Anzahl gezeichneter nicht leerer Kopf- und Fußzeilenelemente zurück oder 0, wenn Satz oder Bereich keinen zutreffenden Inhalt besitzt oder der aktuelle API-Gültigkeitsbereich keine Seiten ändern kann

Anmerkungen

Für jede Kopf- und Fußzeilenrolle verwendet die erste vom Bereich zurückgegebene Seite first, wenn definiert; spätere Seiten verwenden gemäß ihrer physischen Seitennummer odd oder even, und fehlende spezifische Varianten greifen auf default zurück

Eine ausdrücklich definierte leere Variante zeichnet nichts und verhindert den Rückgriff, was leere erste Seiten unterstützt

Jede Vorlage wird vor der Messung für ihre Zielseite erweitert, und HTML-Varianten verwenden das erweiterte Markup zur automatischen Höhenberechnung

Erzeugter Inhalt wird als Paginierungsartefakt markiert, und die ausgewählte Seite, Schrift, der Zeichnerzustand und die Kerning-Einstellung des Aufrufers werden wiederhergestellt

Beispiel

PDF.SetPageHeaderFooterVariant('manual', 'default',
  '<b>Manual</b> — <%PageNo%>/<%TotalPages%>', 36, 0, 0.8, 2, 0, 1);
if PDF.ApplyPageHeaderFooterSet('manual', '3-20')= 0 then
  HandleLayoutError;