AddPageHeaderFooter
页面操作、注释
说明
AddPageHeader 和 AddPageFooter 背后的共享基元。使用当前所选字体以叠加模式在范围内每页的顶部或底部边缘盖印连续行,针对每个目标页面展开盖印标记,并将结果包含在子类型为 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 表示完全不透明 |
| Alignment | 0 在页边距处左对齐,1 在两侧页边距间居中,2 右对齐并保持与右边缘的页边距距离 |
| IsHeader | True 在顶部页边距盖印页眉,False 在底部页边距盖印页脚 |
返回值
已盖印该行的页数;未选择文档、Text 为空或无法选择范围中的任何页面时返回 0
备注
该行使用当前字体和字号测量,因此请先调用 SelectFont。IsHeader 为 True 时,该行位于距顶部边缘 Margin 处;为 False 时,位于距底部边缘 Margin 处,位置根据当前页面高度和文本高度计算。调用返回时将恢复所选页面
示例
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);