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 时使用 first；后续页面按物理页号使用 odd 或 even，缺少特定变体时回退到 default

显式定义的空变体不会绘制任何内容并阻止回退，支持空白首页

每个模板都会在测量前针对其目标页面展开，HTML 变体则使用展开后的标记自动计算高度

生成的内容标记为分页伪影，并恢复调用方选定的页面、字体、绘制器状态和字距调整设置

示例

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;