ApplyPageHeaderFooterSet

Układ strony, Stronicowanie, Tekst HTML

Opis

Stosuje nazwany zestaw nagłówka i stopki do zakresu stron, wybierając wariant według pierwszej strony i parzystości fizycznego numeru strony

Składnia

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

Parametry

SetName	Nazwa bez rozróżniania wielkości liter, wcześniej zarejestrowana za pomocą SetPageHeaderFooterVariant
PageRange	Wyrażenie zakresu stron albo pusty ciąg dla wszystkich stron

Wartości zwracane

Zwraca liczbę narysowanych niepustych elementów nagłówka i stopki albo 0, gdy zestaw lub zakres nie ma odpowiedniej zawartości bądź bieżący zakres interfejsu API nie może zmieniać stron

Uwagi

Dla każdej roli nagłówka i stopki pierwsza strona zwrócona przez zakres używa first, jeśli je zdefiniowano; późniejsze strony używają odd lub even zgodnie z fizycznym numerem strony, a brakujące warianty szczegółowe używają default

Jawnie zdefiniowany pusty wariant niczego nie rysuje i zapobiega użyciu wariantu zastępczego, co obsługuje puste pierwsze strony

Każdy szablon jest rozwijany względem strony docelowej przed pomiarem, a warianty HTML używają rozwiniętego znacznika do automatycznego obliczania wysokości

Wygenerowana zawartość jest oznaczana jako artefakt paginacji, a wybrana przez wywołującego strona, czcionka, stan modułu rysującego i ustawienie kerningu są przywracane

Przykład

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;