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