ApplyPageHeaderFooterSet

頁面版面、分頁、HTML 文字

描述

將具名的頁首/頁尾集合套用到頁面範圍，支援首頁與實體頁奇偶選擇

語法

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

參數

SetName	先前以 SetPageHeaderFooterVariant 登錄的名稱（不分大小寫）
PageRange	頁面範圍運算式，空字串代表所有頁面

傳回值

傳回已繪製的非空頁首/頁尾元素數量；集合或範圍沒有適用內容，或目前 API 範圍不能更動頁面時傳回 0

備註

對每個頁首與頁尾角色，範圍中的第一頁使用 first（若有定義）；後續頁面依實體頁碼使用 odd 或 even，缺少特定變體時回退到 default

明確定義的空變體不繪製任何內容也阻止回退，可用於空白首頁

每個範本都會先對目標頁面展開再量測，HTML 變體使用展開後的標記自動計算高度

產生的內容會標記為分頁 artifact，並還原呼叫者所選的頁面、字型、繪圖器狀態與 kerning 設定

範例

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;