AddPageHeader

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

描述

在所選文件的一或多個頁面上蓋印頁首行。文字以目前選定的字型採覆疊模式繪製,諸如 <%PageNo%> 的蓋印權杖會在量測該行之前,先對每個目標頁面展開,而蓋印的行會封裝在子類型為 Header 的 Pagination 成品中,讓標籤 PDF 讀取器將它視為頁面配件而非重複出現的內容

語法

Delphi

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

參數

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

傳回值

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

備註

此行以目前的字型與大小量測,因此請先呼叫 SelectFont;頁面上既有的內容在覆疊層下方仍保持可見。呼叫傳回時會還原所選的頁面

如需支援 HTML 內容的首頁、奇數頁與偶數頁頁首角色,請參閱 ApplyPageHeaderFooterSet

範例

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
  28, 1, 1);