Main Content

本页采用了机器翻译。点击此处可查看最新英文版本。

mlreportgen.dom.PageRef 类

命名空间: mlreportgen.dom

创建占位符以引用链接目标的页码

全页展开

描述

创建一个占位符来引用链接目标的页码。此对象仅适用于 Word 和 PDF 输 出。对于 Word 输出，打开文档会导致 Word 用该对象指定的链接目标的页码替换该对象。对于 PDF 输出，DOM API 会用其指定的链接目标的页码替换此对象。

提示

使用此对象生成页面引用，例如“请参阅第 15 页了解更多信息”。

mlreportgen.dom.PageRef 类是一个 handle 类。

创建对象

描述

pageRef = PageRef(target) 创建一个引用指定 LinkTarget 对象的页面引用对象。生成输出将此 PageRef 对象替换为包含指定目标的页面编号。

示例

输入参量

全部展开

要引用的链接目标的名称，指定为字符向量。使用 LinkTarget 对象指定目标。

属性

全部展开

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable
true

此文档元素对象的格式规范，指定为格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此元素的格式将被忽略。

属性：

NonCopyable
true

数据类型: cell

样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了此元素在输出文档中的外观，除非由此元素的 Style 属性指定的格式覆盖。要了解有关使用样式表的更多信息，请参阅 使用样式表样式。

注意

Microsoft® Word 输 出忽略样式名称。

属性：

NonCopyable
true

数据类型: char | string

此页面引用的目标名称，指定为字符向量。

mlreportgen.dom.PageRef 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.PageRef 对象的子项，指定为文档元素对象的数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.PageRef 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.PageRef 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开脚本

此示例插入对另一页上的目标的页码引用。使用 LinkTarget 添加目标 mytarget。使用 PageRef 引用包含目标 mytarget 的页面。

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

% Create page footer and add page number to it
footer = PDFPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;
d.CurrentPageLayout.FirstPageNumber = 1;
pageno = Paragraph();
pageno.HAlign = 'center';
append(pageno,Page());
append(footer,pageno);

% Add target to heading object and append heading and para text to document
h = Heading1(LinkTarget('mytarget'));
append(h,'Head Whose Page to Reference');
p = Paragraph('Here is some paragraph text.');
append(d,h);
append(d,p);

% Add another page and insert page reference to target
p1 = Paragraph('The following paragraph contains the page reference.');
p1.Style = {PageBreakBefore(true)};
p2 = Paragraph('See Page ');
p2.WhiteSpace = 'preserve';
ref = PageRef('mytarget');
append(p2,ref);
append(p2,'.');
append(d,p1);
append(d,p2);

close(d);
rptview(d.OutputPath);

版本历史记录

在 R2016a 中推出

另请参阅

| | | | |

主题