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

mlreportgen.dom.NumPages 类

命名空间: mlreportgen.dom

创建文档页数的占位符

全页展开

描述

使用 mlreportgen.dom.NumPages 类的实例为文档的页数创建一个占位符。此对象仅适用于 Word 和 PDF 输出。对于 Word 输出，打开 Word 文档会导致 Word 用文档中的页数替换该对象。对于 PDF 输出，DOM API 在写入文档时会用总页数替换该对象。

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

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

  • "docx"

  • "pdf"

  • "pdfa" (自 R2025a 起)

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

创建对象

描述

num = NumPages 为报告中的总页数创建一个对象。

示例

属性

全部展开

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

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

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性：

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

方法

全部展开

示例

全部折叠

打开脚本

此示例在页脚中插入文档的总页数。使用此类显示当前页码以及总页数，例如第 1 页（共 3 页）。

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

% Create page footer
footer = DOCXPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;

% Define page number and add to footer.
d.CurrentPageLayout.FirstPageNumber = 1;
t = Text('Page ');
t.WhiteSpace = 'preserve';
t1 = Text(' of ');
t1.WhiteSpace = 'preserve';
pageinfo = Paragraph();
pageinfo.HAlign = 'center';
append(pageinfo,t);
append(pageinfo,Page());
append(pageinfo,t1);
append(pageinfo,NumPages());
append(footer,pageinfo);

% Create several pages.
p = Paragraph('Hello World');
append(d,p);
p = Paragraph('Another page');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,clone(p));

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

详细信息

全部展开

版本历史记录

在 R2016a 中推出

另请参阅

| |

主题