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

mlreportgen.dom.TemplateDocumentPart 类

命名空间: mlreportgen.dom

创建文档部件模板

自 R2023b 起

全页展开

描述

此类定义一个文档部件模板对象，您可以将其添加到 mlreportgen.dom.Template 类的对象的 TemplateDocumentParts 属性中。当您关闭 Template 对象时，报告生成器会将这些文档部件模板作为文档部件写入输出模板包（HTML、PDF、DOCX）或模板文档（HTML-FILE）。然后，您可以根据生成的模板中的文档部件模板创建 DocumentPart 对象。

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

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

tdpObject = mlreportgen.dom.TemplateDocumentPart 创建 TemplateDocumentPart 对象，并将 Name 属性设置为 ""。

tdpObject = mlreportgen.dom.TemplateDocumentPart(Name) 创建一个模板对象并将 Name 属性设置为 Name。

示例

输入参量

全部展开

文档模板部分的名称，指定为字符向量或字符串标量。使用名称来识别和访问生成的模板中的文档部件。

属性

全部展开

容器的 HTML 标记名称，指定为字符向量或字符串标量。该名称必须是 HTML 元素，例如 "div"、"section" 或 "article"。

注意

Microsoft® Word 输出忽略 HTML 标记名称。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

文档部件模板的名称，指定为字符向量或字符串标量。使用名称来识别和访问生成的模板中的文档部件。

数据类型: char | string

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

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

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

方法

全部展开

示例

全部折叠

打开实时脚本

导入 mlreportgen.dom 命名空间，这样您就不必包含对象构造函数和方法的完整限定名称。 

import mlreportgen.dom.*

创建 DOCX 模板。

t = Template("bookReportTemplate","docx");
open(t);

创建一个模板文档部分。 

dpt = TemplateDocumentPart("bookRatingPart");

为书名创建一个空位。

title = Heading1();
append(title,TemplateHole("Title","Title of the book"));
append(dpt,title);

为书籍作者创建一个空位。

author = Heading2();
append(author,TemplateHole("Author","Author of the book"));
append(dpt,author);

为图书评级创建一个空位。

rating = Paragraph("I rate this book: ");
rating.WhiteSpace = "preserve";
append(rating,TemplateHole("Rating", "Rating of the book"));
append(rating," out of 5 stars.");
append(dpt,rating);

将模板文档部件添加到模板中。

t.TemplateDocumentParts(end+1) = dpt;
close(t);

要查看模板文档部件或任何默认模板文档部件：

使用以下方法之一打开 bookReportTemplate.dotx：

  • 在 MATLAB® 中，在当前文件夹窗格中，右键点击模板文件并选择在资源管理器中显示。然后右键点击模板文件并选择打开。

  • 在 MATLAB 之外，右键点击模板文件并选择打开。

在 Word 中，打开功能区中的插入选项卡。在文本组中，选择快速部件按钮。下拉菜单将显示您的新 bookRatingPart 模板文档部件以及 mlreportgen.dom.Template 模板标准的其他模板文档部件。

Word Quick Parts dropdown showing the template document parts created by the mlreportgen Template

版本历史记录

在 R2023b 中推出

全部展开

另请参阅

| |

主题