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

mlreportgen.dom.DOCXSubDoc 类

命名空间: mlreportgen.dom

引用外部 Microsoft Word 文档

全页展开

描述

使用 mlreportgen.dom.DOCXSubDoc 类的对象在 Word、PDF 或 HTML 文档中创建对外部 Microsoft® Word 文档的引用。指向引用文档（也称为子文档）的链接被插入到您追加 DOCXSubDoc 对象的父文档中。

当您在 Word 中首次打开父文档时，Word 会显示子文档的链接而不是内容。要用内容替换链接，请从 Word 工具条上的视图选项卡的大纲选项卡中选择展开子文档。rptview 命令在打开 Word 文档时会展开子文档。您还可以使用 docview 来展开和取消链接子文档。

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

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

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

类属性

ConstructOnLoad
true
HandleCompatible
true

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

创建对象

描述

docxSubDocObj = mlreportgen.dom.DOCXSubDoc 创建一个空的文档引用。

docxSubDocObj = mlreportgen.dom.DOCXSubDoc(path) 创建对指定路径中的 Word 文档的引用，并将 Target 属性设置为 path。

示例

属性

全部展开

此引用所针对的文档的路径，指定为字符向量或字符串标量。使用 ASCII 字符。使用以下格式指定涉及映射驱动器的完整路径。

"file:///C:/UserPath/FileName.docx"

属性：

SetAccess
无
Transient
true
NonCopyable
true

数据类型: char | string

该类忽略此属性。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

该类忽略此属性。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

该类忽略此属性。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

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

方法

全部展开

示例

全部折叠

打开脚本
import mlreportgen.dom.*

info = Document('CompanyInfo','docx');
append(info,'XYZ, Inc., makes widgets.');
close(info);

infoPath = info.OutputPath;

rpt = Document('Report','docx');
open(rpt);

append(rpt,Paragraph('About XYZ, Inc.'));

append(rpt,DOCXSubDoc(infoPath));

close(rpt);
rptview(rpt.OutputPath);

详细信息

全部展开

替代函数

mlreportgen.dom.EmbeddedObject

要将 Word 文档以外的文档插入另一个文档，请使用 mlreportgen.dom.EmbeddedObject 类的对象。

要将 Word 文档插入另一个文档，可以使用 DOCXSubDoc 或 EmbeddedObject 类的对象。要决定使用哪个类，请考虑以下准则：

  • 如果您希望父文档最初显示指向子文档的链接，请使用 DOCXSubDoc 对象。当父文档链接到大纲视图中的一组子文档时，您可能希望首先显示链接。如果您希望父文档显示子文档内容，而不管您是在 Word 中打开父文档还是使用 rptview 打开，请使用 EmbeddedObject 对象。

  • 如果您想移动父文档而不移动子文档，请使用 EmbeddedObject 对象。

版本历史记录

在 R2014b 中推出

另请参阅

| | |