AddPageNumberPlaceholder

页面布局、分页、文本

描述

在所选页面上记录文本框,并延迟其绘制,直到最终页面和章节计数已知

语法

Delphi

Function TPDFlib.AddPageNumberPlaceholder(Left, Top, Width, Height: Double; Const Text: WideString; Options: Integer): Integer;

ActiveX

Function PDFlib::AddPageNumberPlaceholder(Left As Double, Top As Double, Width As Double, Height As Double, Text As String, Options As Long) As Long

DLL

int DLAddPageNumberPlaceholder(int InstanceID, double Left, double Top, double Width, double Height, const wchar_t* Text, int Options);
int DLAddPageNumberPlaceholderA(int InstanceID, double Left, double Top, double Width, double Height, const char* Text, int Options);

参数

Left, Top, Width, Height当前坐标系中的文本框几何信息
Text包含分页令牌和普通文本的模板
Options从 0 到 5 的垂直放置和不换行选项,其含义与 DrawTextBox 相同

Tokens

<%PageNo%>物理选定页码
<%TotalPages%>最终文档页数
<%ChapterPageNo%>当前章节中从 1 开始计数的页码
<%ChapterTotalPages%>当前章节的最终页数
<%ChapterName%>由 StartPageNumberChapter 注册的名称

返回值

返回从 1 开始的占位符标识符;几何形状、选项、文本或选择无效,或者文档中的占位符已解析时,返回 0

备注

调用捕获所选字体、文本大小、颜色、对齐、间距、字距调整、装饰、缩放、原点和已转换文本框几何图形,而不绘制页面内容

日期、时间和自定义 OnCalcVariable 令牌与 ExpandVariableTokens 使用相同规则

在完整页面结构稳定后且保存前,恰好调用一次 ResolvePageNumberPlaceholders