SetPageHeaderFooterVariant

页面布局、分页、HTML 文本

描述

在命名的可复用页眉页脚集中创建或替换一个变体

语法

Delphi

Function TPDFlib.SetPageHeaderFooterVariant(Const SetName, VariantName,
  Text: WideString; Margin, Height, Opacity: Double; Alignment,
  IsHeader, RichText: Integer): Integer;

ActiveX

Function PDFlib::SetPageHeaderFooterVariant(SetName As String,
  VariantName As String, Text As String, Margin As Double,
  Height As Double, Opacity As Double, Alignment As Long,
  IsHeader As Long, RichText As Long) As Long

DLL

int DLSetPageHeaderFooterVariant(int InstanceID, const wchar_t* SetName,
  const wchar_t* VariantName, const wchar_t* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);
int DLSetPageHeaderFooterVariantA(int InstanceID, const char* SetName,
  const char* VariantName, const char* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);

参数

SetName	属于同一模板集的变体所共用的不区分大小写名称
VariantName	`default`、`first`、`odd` 或 `even`，不区分大小写匹配
Text	为每个所选页面单独展开的文本或 HTML 模板；空值会创建明确的空白变体，以禁止回退
Margin	距相关页面边缘的非负距离
Height	内容框高度，或为 0 时自动测量纯文本行或 HTML 内容
Opacity	从 0（透明）到 1（不透明）的值
Alignment	0 表示左对齐，1 表示居中，2 表示右对齐
IsHeader	页眉为 1，页脚为 0
RichText	1 表示将 `Text` 渲染为 HTML，0 表示使用当前选定的字体和绘制器状态

返回值

变体存储成功时返回 1；名称、变体、数值、对齐方式或标志无效时返回 0

备注

随后使用相同集合名称、变体名称及页眉或页脚角色的调用会替换现有定义

模板支持和号及 <%name%> 字段，与 AddPageHeader 相同，包括由 OnCalcVariable 解析的自定义变量

定义属于 TPDFlib 实例，可应用于多个文档

示例

PDF.SetPageHeaderFooterVariant('manual', 'first', '', 36, 0, 1, 0, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'odd', 'Chapter — <%PageNo%>', 36, 0, 1, 2, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'even', '<%PageNo%> — Chapter', 36, 0, 1, 0, 1, 0);