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

mlreportgen.dom.PageRef 类

命名空间: mlreportgen.dom

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

全页展开

描述

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

提示

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

要了解可以将 mlreportgen.dom.PageRef 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.PageRef 对象追加到 DOM 类对象上。

此类仅与以下 MATLAB® Report Generator™ 输出类型兼容：

  • "docx"

  • "pdf"

  • "pdfa" (自 R2025a 起)

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

创建对象

描述

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

示例

输入参量

全部展开

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

属性

全部展开

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

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

注意

Microsoft® Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开脚本

此示例插入对另一页上的目标的页码引用。使用 mytarget 添加目标 LinkTarget。使用 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 中推出

另请参阅

| | | | |

主题