mlreportgen.dom.EmbeddedObjectclass

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

文档中嵌入一个文件

描述

使用的对象mlreportgen.dom.EmbeddedObject在文档类中嵌入一个文件。在一个文档中嵌入一个文件的优势,而不是链接到它,你可以移动文档不动目标文件。

你可以添加一个mlreportgen.dom.EmbeddedObjectDOM对象,对象的类:

mlreportgen.dom.Document
mlreportgen.dom.DocumentPart
mlreportgen.dom.Paragraph
mlreportgen.dom.TableEntry
mlreportgen.dom.TableHeaderEntry
mlreportgen.dom.ListItem

附加的效果EmbeddedObjectDOM对象的对象取决于文档输出类型和外部文件类型,如这个表所述。

文档输出类型	外部文件类型	行为
词	`xlsx`,`pptx`,`多克斯`	文档中嵌入的外部文件,插入一个对象链接和嵌入(OLE)嵌入的文件链接。如果你打开文档没有首先打开它`rptview`,OLE链接显示一个图像占位符。当你打开文档`rptview`,OLE链接显示的图像嵌入的文件内容。查看和编辑嵌入的文件内容,双击图片。
词	以外的任何类型`xlsx`,`pptx`,或`多克斯`	不嵌入文档中的文件。插入超链接到外部文件中。
PDF	任何	文档中嵌入的外部文件,插入一个回形针图标的注释。打开嵌入文件,双击图标。看到回形针图标,你必须打开PDF MATLAB之外^®。如果你还没有看到回形针图标,试着使用不同的PDF查看器打开PDF,等Adobe^®杂技演员^®。如果你需要打开PDF使用查看器不显示回形针图标,而不是嵌入文档时,考虑使用一个链接到文档`mlreportgen.dom.ExternalLink`对象。
HTML	任何	文档中嵌入的外部文件,插入一个嵌入式文件的超链接。在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 (路径,linkText,styleName属性)指定模板样式的名称用于链接文本。这个构造函数创建一个mlreportgen.dom.Text对象的链接文本和设置StyleName属性财产的文本对象styleName属性。

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

输入参数

全部展开

`路径`- - - - - -路径文件嵌入
特征向量|字符串标量

嵌入文件的路径,指定为一个特征向量或字符串标量。

`linkText`- - - - - -链接文本
特征向量|字符串标量

链接文本,指定为一个特征向量或字符串标量。链接文本只适用于当引用一个文件是一个超链接。

`linkTextObj`- - - - - -链接文本
`mlreportgen.dom.Text`对象

链接文本,作为指定mlreportgen.dom.Text对象。链接文本只适用于当引用一个文件是一个超链接。

`styleName属性`- - - - - -链接文本的样式名称
特征向量|字符串标量

模板样式的名称使用的链接文本,指定为一个特征向量或字符串标量。

属性

全部展开

`目标`- - - - - -文件中嵌入在文档的路径
特征向量|字符串标量

在文档中嵌入文件的路径,指定为一个特征向量或字符串标量。

`StyleName属性`- - - - - -样式用于链接的名称
特征向量|字符串标量

风格的名称使用链接时,指定为一个特征向量或字符串标量。指定的风格StyleName属性属性必须在模板中定义用于创建的文档EmbeddedObject是附加的。的StyleName属性属性只适用于当参考文件是一个超链接。

`风格`- - - - - -格式定义链接的风格
单元阵列的DOM对象格式

格式定义一个链接的风格,指定为一个单元阵列的DOM对象格式。中指定的格式风格属性覆盖格式指定的模板样式。的风格属性只适用于当参考文件是一个超链接。

`CustomAttributes`- - - - - -自定义属性的链接
`[]`|单元阵列的`mlreportgen.dom.CustomAttribute`对象

指定的一个链接,自定义属性的单元阵列mlreportgen.dom.CustomAttribute对象。输出格式必须支持自定义属性。金宝app的CustomAttributes属性只适用于当参考文件是一个超链接。

`父`- - - - - -文档元素的父
DOM对象

这个文档元素的母公司,指定为一个DOM对象。这个属性是只读的。

`孩子们`- - - - - -文档元素的孩子
DOM对象的数组

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

`标签`- - - - - -这个文档元素标记
特征向量|字符串标量

标记文档元素,指定为一个特征向量或字符串标量。

DOM生成一个session-unique标签创建这个对象的一部分。生成的标签的形式类:ID,类是对象类和ID的值Id对象的属性。指定您自己的标记值可以帮助您确定问题发生在文档生成。

`Id`- - - - - -本文档ID元素
特征向量|字符串标量

本文档ID元素,指定为一个特征向量或字符串标量。DOM生成一个session-unique ID创建文档元素。你可以指定自己的ID。

方法

全部展开

公共方法

附加

追加文本、图像或一个自定义元素的引用文件在一个文档中。使用附加与一个mlreportgen.dom.EmbeddedObject你使用对象一样附加与一个mlreportgen.dom.ExternalLink对象。

的附加方法只适用于当参考文件是一个超链接。

克隆

克隆=克隆(embeddedObj)创建一个副本mlreportgen.dom.EmbeddedObject对象。

重复的内容文档,使用克隆。不相同的对象附加到文档超过一次。

例子

全部折叠

嵌入一个Word文档在不同的文档里

创建一个Word文档,CompanyInfo.docx,嵌入在一个Word文档,CompanyReport.docx。

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

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

文档文本,“XYZ公司。”,followed by a clickable image that reads XYZ, Inc., makes widgets.

打开嵌入文档,双击图片。

在一个HTML文档中嵌入一个PDF

创建一个PDF,bio.pdf,嵌入在HTML文档中,author.html。指定的链接文本mlreportgen.dom.EmbeddedObject构造函数。让绿色的联系。

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

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

打开嵌入文档,打开作者/ root.htmlMATLAB之外。

选择功能

`mlreportgen.dom.DOCXSubDoc`

将Word文档插入到另一个文档时,您可以使用对象的DOCXSubDoc或EmbeddedObject类。决定使用哪个类,考虑这些指导方针:

使用DOCXSubDoc对象如果你想父文档显示最初子文档的链接。您可能想要显示链接最初当父文档链接的子文档在大纲视图中。使用EmbeddedObject对象如果你想父文档显示的子文档内容无论你打开父文档在字(词)或通过使用rptview。
使用EmbeddedObject对象如果你想移动父文档的子文档。