AddPageHeaderFooter

頁面操作, 註解和熱點連結

描述

AddPageHeader 與 AddPageFooter 背後共用的基礎 primitive。會在範圍內每個頁面的上緣或下緣蓋印行,使用目前選定的字型採覆疊模式、對每個目標頁面展開蓋印權杖,並將結果封裝在子類型為 Header 或 Footer 的 Pagination 成品中

語法

Delphi

Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
  Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;

參數

PageRange頁面範圍運算式,空字串代表所有頁面
Text行文字;ExpandStampTokens 可辨識的權杖會對每個目標頁面展開
Margin上緣(頁首)或下緣(頁尾)到該行的距離,以 PDF 點為單位
Opacity文字不透明度,介於 0 與 1 之間,1 表示完全不透明
Alignment0 表示在邊距處靠左對齊、1 表示在兩側邊距之間置中、2 表示靠右對齊並與右緣保持邊距
IsHeaderTrue 在上邊距蓋印頁首,False 在下邊距蓋印頁尾

傳回值

蓋印該行的頁數;當未選取文件、Text 為空,或範圍中無任何頁面可選取時為 0

備註

此行以目前的字型與大小量測,因此請先呼叫 SelectFont。IsHeader 為 True 時,該行位於距上緣 Margin 處;為 False 時位於距下緣 Margin 處,依目前的頁面高度與文字高度計算。呼叫傳回時會還原所選的頁面

範例

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);