主要内容

mlreportgen.dom.EmbeddedObject类

包:mlreportgen.dom
超类:mlreportgen.dom.ExternalLink

在文档中嵌入一个文件

自从R2020a

描述

对象的对象mlreportgen.dom.EmbeddedObject类将文件嵌入到文档中。将文件嵌入到文档中而不是链接到文档的优点是,您可以在不移动目标文件的情况下移动文档。

你可以添加mlreportgen.dom.EmbeddedObject这些DOM类的对象到对象:

  • mlreportgen.dom.Document

  • mlreportgen.dom.DocumentPart

  • mlreportgen.dom.Paragraph

  • mlreportgen.dom.TableEntry

  • mlreportgen.dom.TableHeaderEntry

  • mlreportgen.dom.ListItem

附加的效果EmbeddedObject对象转换为DOM对象取决于文档输出类型和外部文件类型,如表中所述。

文档输出类型 外部文件类型 行为
xlsxpptx多克斯

将外部文件嵌入到文档中,并将对象链接和嵌入(OLE)链接插入到嵌入文件。

如果你没有先用rptview时,OLE链接显示一个占位符图像。打开文档后rptview时,OLE链接显示嵌入文件内容的图像。要查看和编辑嵌入的文件内容,双击图像。

任何类型,除了xlsxpptx,或多克斯

不将文件嵌入到文档中。插入到外部文件的超链接。

PDF 任何

在文档中嵌入外部文件,并插入具有回形针图标的注释。要打开嵌入的文件,双击图标。

要查看回形针图标,必须在MATLAB之外打开PDF®.如果仍然没有看到回形针图标,请尝试使用不同的PDF查看器打开PDF,例如Adobe®杂技演员®.如果需要使用不显示回形针图标的查看器打开PDF,而不是嵌入文档,请考虑使用mlreportgen.dom.ExternalLink对象。

超文本标记语言 任何

在文档中嵌入外部文件,并插入到嵌入文件的超链接。

在HTML文档中,只有在MATLAB之外打开文档时,超链接才能工作。

一列纵队HTML 任何

不将文件嵌入到文档中。插入到外部文件的超链接。

只有在MATLAB之外打开文档时,超链接才能工作。

mlreportgen.dom.EmbeddedObject类是一个处理类。

类属性

ConstructOnLoad
真正的
HandleCompatible
真正的

有关类属性的信息,请参见类属性

创建

描述

embObj= mlreportgen.dom.EmbeddedObject ()创建一个空EmbeddedObject对象。要指定要嵌入的文件,请使用目标财产。

例子

embObj= mlreportgen.dom.EmbeddedObject (路径设置目标属性设置为要嵌入的文件的路径。

例子

embObj= mlreportgen.dom.EmbeddedObject (路径linkText还指定链接文本。只有当对文件的引用是超链接时,链接文本才适用。此构造函数创建一个mlreportgen.dom.Text对象来保存链接文本。

embObj= mlreportgen.dom.EmbeddedObject (路径linkTextstyleName属性指定要用于链接文本的模板定义样式的名称。此构造函数创建一个mlreportgen.dom.Text对象来保存链接文本,并设置StyleName属性的属性文本对象styleName属性

embObj= mlreportgen.dom.EmbeddedObject (路径linkTextObj使用一个mlreportgen.dom.Text对象指定链接文本。

输入参数

全部展开

要嵌入的文件的路径,指定为字符向量或字符串标量。

链接文本,指定为字符向量或字符串标量。只有当对文件的引用是超链接时,链接文本才适用。

链接文本,指定为mlreportgen.dom.Text对象。只有当对文件的引用是超链接时,链接文本才适用。

要用于链接文本的模板定义样式的名称,指定为字符向量或字符串标量。

属性

全部展开

要嵌入到文档中的文件的路径,指定为字符向量或字符串标量。

要用于链接的样式的名称,指定为字符向量或字符串标量。属性指定的样式StyleName属性属性必须在用于创建所指向的文档的模板中定义EmbeddedObject是附加的。的StyleName属性属性仅在对文件的引用是超链接时应用。

定义链接样式的格式,指定为DOM格式对象的单元格数组。指定的格式风格属性重写由模板定义的样式指定的格式。的风格属性仅在对文件的引用是超链接时应用。

的单元格数组指定的链接的自定义属性mlreportgen.dom.CustomAttribute对象。输出格式必须支持自定义属性。金宝app的CustomAttributes属性仅在对文件的引用是超链接时应用。

此文档元素的父元素,指定为DOM对象。此属性是只读的。

属性:

GetAccess
公共
SetAccess
私人
NonCopyable
真正的

此文档元素的子元素,指定为DOM对象数组。此属性是只读的。

标记,指定为字符向量或字符串标量。

DOM生成一个会话唯一标记,作为创建该对象的一部分。生成的标记具有CLASS:ID的形式,其中CLASS是对象类,ID是对象类的值Id对象的属性。指定您自己的标记值可以帮助您确定在文档生成过程中发生问题的位置。

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
真正的

数据类型:字符|字符串

此文档元素的ID,指定为字符向量或字符串标量。DOM在创建文档元素时生成一个会话唯一ID。您可以指定自己的ID。

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
真正的

数据类型:字符|字符串

方法

全部展开

例子

全部折叠

创建一个Word文档,CompanyInfo.docx,并将其嵌入到第二个Word文档中,CompanyReport.docx

进口mlreportgen.dom。*doc1 =文档(“CompanyInfo”“多克斯”);追加(doc1“XYZ, Inc.,生产小部件。”);关闭(doc1);doc1Path = doc1.OutputPath;doc2 =文档(“CompanyReport”“多克斯”);打开(doc2);para = append(doc2,段落(“关于XYZ公司”));追加(doc2 EmbeddedObject (doc1Path));关闭(doc2);rptview (doc2);

文档,CompanyReport.docx,显示嵌入文件的图像。

文档文本“关于XYZ, Inc.”,后面跟着一个可点击的图像,上面写着XYZ, Inc.,用于制作小部件。

要打开嵌入的文档,双击图像。

创建一个PDF,bio.pdf,并将其嵌入到HTML文档中,author.html.属性中的链接文本mlreportgen.dom.EmbeddedObject构造函数。将链接设置为绿色。

进口mlreportgen.dom。*doc1 =文档(“生物”“pdf”);帕拉=“作者1970年出生于纽约州纽约。”;追加(doc1, para);关闭(doc1);doc2 =文档(“作者”“html”);doc2。PackageType =“解压缩”;embeddobj = EmbeddedObject(“bio.pdf”的传记作者);embedObj。风格={Color(“绿色”)};p =段落();追加(p, embedObj);追加(doc2 p);关闭(doc2);rptview (doc2);

文档作者显示到嵌入文档的链接。

链接文本是“作者简介”。链接和文本是绿色的。

要打开嵌入的文档,请打开作者/ root.html在MATLAB之外。

选择功能

mlreportgen.dom.DOCXSubDoc

类的对象可将Word文档插入到另一个文档中DOCXSubDocEmbeddedObject类。要决定使用哪个类,请考虑以下指南:

  • 使用DOCXSubDoc对象,如果您希望父文档最初显示到子文档的链接。当父文档链接到大纲视图中的一组子文档时,您可能希望最初显示链接。使用EmbeddedObject如果您希望父文档显示子文档内容,无论您是在Word中打开父文档还是使用rptview

  • 使用EmbeddedObject如果您希望在不移动子文档的情况下移动父文档,则可以使用。

版本历史

R2020a中引入

全部展开