mlreportgen.dom.Documentclass

包:mlreportgen.dom

文档容器

描述

使用的对象mlreportgen.dom.Document类代表一个文档对象模型(DOM)文档。使用文档对象属性来指定:

是否要生成一个HTML,微软^®词,或者PDF文档
在哪里以及如何存储生成的文件吗
模板使用格式文档

的mlreportgen.dom.Document类是一个处理类。

类属性

`ConstructOnLoad`	`真正的`
`HandleCompatible`	`真正的`

类属性的信息,请参阅类属性。

创建

描述

documentObj= mlreportgen.dom.Document ()创建一个文档对象的默认属性值,指定输出文件命名Untitled.htmx在当前文件夹,使用默认的HTML模板。

documentObj= mlreportgen.dom.Document (outputPath)指定输出文件的路径和名称并设置OutputPath财产outputPath。

例子

documentObj= mlreportgen.dom.Document (outputPath,类型)还指定了类型和设置的输出类型财产类型。

documentObj= mlreportgen.dom.Document (outputPath,类型,templatePath)还指定模板文件的路径和名称并设置TemplatePath财产templatePath。

属性

全部展开

`OutputPath`- - - - - -输出文件的路径和名称为本文档或文件夹
字符串标量|特征向量

输出文件的路径和名称为本文档或文件夹,指定为一个字符串标量或特征向量。您可以指定绝对路径或相对于当前文件夹的路径。你可以设置这个属性只在打开文档。

默认值是一个文件或文件夹命名的道路无标题的在当前文件夹。如果OutputPath指定一个文件,你不指定文件扩展名,DOM API添加一个扩展的基础上类型财产。

是否OutputPath指定一个文件或文件夹的路径依赖的价值PackageType属性,如表所示。

`PackageType`	`OutputPath`价值
`“压缩”`或`“列纵队”`	ZIP文件的路径和名称或单个文件
`“解压缩”`	解压缩文件的文件夹
`“两个”`	路径和名称的ZIP文件和文件夹解压文件

请注意

生成PDF报告云开,等MATLAB^®驱动™会导致一个错误,是由于文件报告生成软件和云驱动器之间的争用同步软件。为了避免这种错误,生成报告的本地驱动器上没有与云同步。考虑编写一个脚本,该脚本生成一个报告在一个本地驱动器上,然后将报告复制到云驱动器。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`PackageType`- - - - - -包装为生成的文件
`“压缩”`|`“解压缩”`|`“两个”`|`“列纵队”`

包装用于生成的文件,表中指定的值。您可以指定PackageType作为一个字符串标量或特征向量。

价值	金宝app支持报告类型	描述
`“压缩”`	`“多克斯”`或`“html”`	生成的报告作为一个压缩文件,在指定的位置`OutputPath`财产。ZIP文件的扩展相匹配的文档类型(`。docx`字输出或`.htmx`对于HTML输出。)例如,如果文档`类型`是`多克斯`和`OutputPath`是`s: \ docs \ MyDoc`,输出是打包成一个ZIP文件命名`s: \ docs \ MyDoc.docx`。
`“解压缩”`	`“多克斯”`或`“html”`	生成报告作为单独的文件在一个文件夹的文件名称`OutputPath`财产。例如,如果`OutputPath`是`s: \ docs \ MyDoc`,输出文件夹`s: \ docs \ MyDoc`。
`“两个”`	`“多克斯”`或`“html”`	生成压缩和解压输出。
`“列纵队”`	`“pdf”`或`“html文件”`	生成的报告作为一个单独的文件。

生成一个HTML报告,您可以打开没有拉开,集类型来“html”和PackageType来“解压缩”或“两个”。在包含生成的文件的文件夹,打开root.html文件。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`ForceOverwrite`- - - - - -是否覆盖现有的输出文件
`真正的`(默认)|`假`

是否覆盖现有的输出文件,指定为真正的或假。将此属性设置为真正的覆盖现有的名称相同的输出文件。如果此属性假和一个可写的文件名称相同的存在,关闭这个文档会导致一个错误。如果现有的文件是只读的,关闭这个文档会导致一个错误,不管这个属性设置。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`StreamOutput`- - - - - -选择流输出到磁盘
`假`(默认)|`真正的`

选择流输出到磁盘,指定为真正的或假。默认情况下,文档元素存储在内存中,直到文件被关闭。将此属性设置为真正的写文档元素到磁盘的元素附加到文档。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`TitleBarText`- - - - - -对HTML浏览器标题栏的文本
字符串标量|特征向量

文本的HTML浏览器标题栏,指定为一个字符串标量或特征向量。对HTML文档,这个属性指定的文本出现在浏览器的标题栏用于显示该文档。字和PDF文档忽略该属性。

设置该属性之前打开文档。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`HTMLHeadExt`- - - - - -自定义内容的HTML标题
字符串标量|特征向量

自定义内容的HTML标题,指定为一个字符串标量或特征向量。附加到此属性的值<头>指定的元素后的这个文档内容标题部分的文档模板。设置该属性只有在打开文档。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`TemplatePath`- - - - - -路径模板来使用
字符串标量|特征向量

使用模板的完整路径,指定为一个字符串标量或特征向量。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`类型`- - - - - -类型的输出
`“html”`(默认)|`“多克斯”`|`“pdf”`|`“html文件”`

类型的输出,指定为一个字符串标量或特征向量:

“html”——HTML输出打包压缩或解压缩文件夹包含HTML文档的文本、图像、样式表和JavaScript^®文件
“多克斯”字的输出
“pdf”- - - - - - PDF输出
“html文件”——一个HTML文件,其中包含文本,样式表,JavaScript,报告和图片

如果你指定一个模板使用TemplatePath财产,必须符合模板类型论点。您必须指定一个模板与一个字模板扩展(.dotx)字输出,一个HTML模板包扩展(.htmtx)的HTML输出,一个PDF模板包扩展(.pdftx)PDF输出和单个HTML模板扩展(.htmt)html文件输出。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`CurrentHoleId`- - - - - -在文档ID的洞
特征向量

指定的当前文档中洞,ID作为特征向量。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`CurrentHoleType`- - - - - -当前类型的洞
`“内联”`|`“块”`

当前模板孔的类型,指定为“内联”或“块”。

内联洞是一个段落元素可以包含文档元素:文本,图像,LinkTarget,ExternalLink,InternalLink,CharEntity,或AutoNumber。
一块孔可以包含一个段,表,OrderedList,UnorderedList,DocumentPart,或集团元素。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`CurrentPageLayout`- - - - - -目前这个文档的页面布局
`mlreportgen.dom.DOCXPageLayout`对象|`mlreportgen.dom.PDFPageLayout`对象|`[]`

当前页面布局文件,指定为一个mlreportgen.dom.DOCXPageLayout对象,mlreportgen.dom.PDFPageLayout对象,或[]。这个属性适用于词和PDF文档。是一个Word文档的值DOCXPageLayout对象,该对象指定当前页面布局。是一个PDF文档的值PDFPageLayout对象如果当前文档指定一个页面布局。HTML文档的值总是[]。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`OpenStatus`- - - - - -打开状态的文档
`未开封的`(默认)|`“开放”`|`“关闭”`

打开本文档的状态,指定为未开封的,“开放”,或“关闭”。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`父`- - - - - -父这个DOM API的对象
DOM API的对象

父母的DOM API对象,指定为一个DOM API对象。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`孩子们`- - - - - -这个DOM API对象
DOM API对象的数组

这个DOM API对象,指定为DOM API对象数组。

属性:

`GetAccess`	`公共`
`SetAccess`	`私人`
`瞬态`	`真正的`
`NonCopyable`	`真正的`

`标签`- - - - - -这个DOM API对象标签
特征向量|字符串标量

标记这个DOM API对象,指定为一个特征向量或字符串标量。

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

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

`Id`- - - - - -这个DOM API对象ID
特征向量|字符串标量

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

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`真正的`

方法

全部展开

公共方法

`addHTML`	HTML字符串附加到文档
`addHTMLFile`	HTML文件的内容附加到文档
`附加`	附加DOM或MATLAB对象文件
`关闭`	关闭文档
`createAutoNumberStream`	创建编号流
`mlreportgen.dom.Document.createTemplate`	创建DOM模板文件
`填满`	生成文档洞填充内容
`getAutoNumberStream`	返回流编号
`mlreportgen.dom.Document.getCoreProperties`	得到文档或模板的核心属性
`mlreportgen.dom.Document.getImageDirectory`	得到图像文件夹的文档
`mlreportgen.dom.Document.getImagePrefix`	生成的图像名称前缀
`getMainPartPath`	返回路径的主要部分的文档输出方案
`mlreportgen.dom.Document.getOPCMainPart`	返回主要部分的文档,文档,或模板
`moveToNextHole`	文档添加点移动到下一个模板孔
`开放`	打开文档
`包`	OPC部分文件添加到文档包
`mlreportgen.dom.Document.setCoreProperties`	设置OPC核心属性输出文档或模板

例子

全部折叠

创建一个Word文档

打开生活的脚本

创建一个Word文档,添加内容,查看报告在字(词)。

进口mlreportgen.dom。*;d =文档(“mydoc”,“多克斯”);追加(d,“Hello World”);关闭(d);rptview (d);

创建一个HTML文档作为一个单独的文件

创建一个HTML文档作为一个HTML文件,其中包含一个图像。这个例子假定有一个MyImage.jpg文件和一个myHTMLTemplate.htmtHTML模板文件。

创建一个文档,它的输出是一个HTML文件,并使用该模板myHTMLTemplate。在报表中添加文本和图像。关闭并查看文档。

进口mlreportgen.dom。*;d =文档(“mydoc”,“html文件”,“myHTMLTemplate.htmt”);开放(d);追加(d,“Hello world”);追加(d、图像(“C: / / LocalSystem / MyImage.jpg图像”));关闭(d);rptview (d);

版本历史

介绍了R2014b

另请参阅

mlreportgen.dom.DocumentPart|mlreportgen.dom.Text|mlreportgen.dom.Paragraph|mlreportgen.dom.Image

主题

创建报告的容器

mlreportgen.dom.Documentclass

描述

类属性

创建

描述

属性

OutputPath- - - - - -输出文件的路径和名称为本文档或文件夹字符串标量|特征向量

属性:

PackageType- - - - - -包装为生成的文件“压缩”|“解压缩”|“两个”|“列纵队”

属性:

ForceOverwrite- - - - - -是否覆盖现有的输出文件真正的(默认)|假

属性:

StreamOutput- - - - - -选择流输出到磁盘假(默认)|真正的

属性:

TitleBarText- - - - - -对HTML浏览器标题栏的文本字符串标量|特征向量

属性:

HTMLHeadExt- - - - - -自定义内容的HTML标题字符串标量|特征向量

属性:

TemplatePath- - - - - -路径模板来使用字符串标量|特征向量

属性:

类型- - - - - -类型的输出“html”(默认)|“多克斯”|“pdf”|“html文件”

属性:

CurrentHoleId- - - - - -在文档ID的洞特征向量

属性:

CurrentHoleType- - - - - -当前类型的洞“内联”|“块”

属性:

CurrentPageLayout- - - - - -目前这个文档的页面布局mlreportgen.dom.DOCXPageLayout对象|mlreportgen.dom.PDFPageLayout对象|[]

属性:

OpenStatus- - - - - -打开状态的文档未开封的(默认)|“开放”|“关闭”

属性:

父- - - - - -父这个DOM API的对象DOM API的对象

属性:

孩子们- - - - - -这个DOM API对象DOM API对象的数组

属性:

标签- - - - - -这个DOM API对象标签特征向量|字符串标量

属性:

Id- - - - - -这个DOM API对象ID特征向量|字符串标量

属性:

方法