主要内容

mlreportgen.dom.Templateclass

包:mlreportgen.dom
超类:mlreportgen.dom.Document

创建报表模板对象

扩展所有的页面

描述

使用mlreportgen.dom.Template对象创建报告模板。例如,您可以添加DOM内容,如文本,段,或图像对象,TemplateHole对象模板包含固定内容的对象来创建一个模板生成内容的漏洞。

请注意

词Mac不支持为DOM API创建孔模板。金宝app如果您需要创建一个字模板生成Mac Word文档,您可以使用DOM API创建一个模板。创建一个模板对象和使用mlreportgen.dom.TemplateHole增加孔。另外,使用微软®词创建模板和模板复制到你的Mac。

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

创建

描述

templateObj=模板()创建一个模板对象和设置TemplatePath财产Untitled.htmtx。

templateObj=模板(templatePath)创建一个模板对象和设置TemplatePath财产templatePath。如果templatePath不包括文件扩展名,类型属性设置为默认值、HTML。

例子

templateObj=模板(templatePath,文件类型)还设置了类型财产文件类型。如果templatePath包括文件扩展名文件类型必须匹配指定的文件扩展名templatePath。

templateObj=模板(templatePath,文件类型,sourceTemplatePath)创建一个模板对象基于指定的模板sourceTemplatePath。

输入参数

全部展开

路径模板使用新模板为基础,指定为一个字符串标量或特征向量。源模板类型必须匹配文件类型论点。

属性

全部展开

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

只读属性是本文档中当前的洞洞ID。

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

  • 内联洞是一个段落元素可以包含文档元素:文本,图像,LinkTarget,ExternalLink,InternalLink,CharEntity,AutoNumber。

  • 一块孔可以包含一个段,表,OrderedList,UnorderedList,DocumentPart,或集团。

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

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

数据类型:逻辑

自定义内容的HTML标题,指定为一个特征向量。

数据类型:字符

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

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
真正的

数据类型:字符|字符串

这只读属性列表打开这个文档元素的状态。

输出文件或文件夹的路径,指定为一个特征向量。如果你不指定文件扩展名,DOM添加一个扩展基于文档的格式。你可以设置这个属性只在打开文档。

解压缩输出包装,指定输出文件的文件夹的路径。默认是当前文件夹。

包装为生成输出文件,指定这些值之一:

  • “压缩”——仅适用于词、PDF和多文件的HTML输出。

  • “解压缩”——仅适用于词、PDF和多文件的HTML输出。

  • “两个”——仅适用于词、PDF和多文件的HTML输出。

  • “列纵队”——创建报告作为一个单独的文件。如果你设置文档的这个值出现类型财产html文件的。你不能自己设置或修改这个值。

压缩包装,文档输出是一个zip文件位于指定的位置OutputPath财产。zip文件的扩展相匹配的文档类型:多克斯字输出,pdftxPDF输出,或htmtxHTML输出。例如,如果文档类型多克斯和OutputPath是s: \ docs \ MyDoc,输出是打包成一个zip文件命名s: \ docs \ MyDoc.docx。

解压缩包装,文档输出存储在一个文件夹的根文件名称OutputPath财产。例如,如果OutputPath是s: \ docs \ MyDoc,输出文件夹s: \ docs \ MyDoc。

如果你设置PackageType来这两个报告生成,产生压缩和解压输出。

数据类型:字符

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

数据类型:逻辑

本文档标签标识。标签的形式类:ID,在那里类文档类和吗ID的价值吗Id对象的属性。

一个示例指定自己的标签值的原因是,让它更容易确定一个问题发生在文档生成。

完整路径模板来创建、指定为字符串标量或特征向量,可以包括文件扩展名。文件扩展名可以这些值之一:

扩展 文件类型
.htmtx

压缩的HTML
。docx

微软文字处理软件
.htmt

一列纵队HTML
. pdf

PDF

对HTML文档,这个属性指定的文本出现在浏览器的标题栏用于显示该文档。字和PDF文档忽略该属性。

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

输出文件类型,指定为一个字符串标量或字符向量与这些值之一:

价值 文件类型
“htmtx”

压缩的HTML
“多克斯”

微软文字处理软件
“htmt”

一列纵队HTML
“pdf”

PDF

  • “html”——HTML输出压缩或解压缩文件夹包含HTML文档的文本、图像、样式表和JavaScript®文件

  • “多克斯”字的输出

  • html文件的——HTML输出组成的单个文件包含文本、样式表、JavaScript和图片的报告

  • “pdf”- - - - - - PDF输出

如果你指定一个模板使用TemplatePath财产,必须符合模板类型财产。

方法

全部展开

例子

全部折叠

这个示例创建一个模板的标题和一个洞一个洞的作者。你可以改变的价值类型变量来创建一个模板的另一个类型。

进口mlreportgen.dom。*;类型=“多克斯”;%对象创建一个模板t =模板(“mytemplate”、类型);%添加一个标题孔模板和应用标题样式洞= append (t, TemplateHole (“标题”));洞。描述= (的标题描述);洞。DefaultHoleStyleName =“标题”;%添加一段字幕格式样板文本和应用%的位置的段落,并保留空白文本p =段(的作者:);p。StyleName属性=“字幕”;p。风格= {OuterMargin (' 0 ',' 0 ',“1”,“1”)};p。空白=“保存”;%将内联洞段洞= append (p, TemplateHole (“作者”));追加(t, p);关闭(t);

下面的例子使用了模板来填补这个漏洞。

%创建一个文档TitleAuthor mytemplate使用模板。rpt =文档(“TitleAuthor”、类型“mytemplate”);打开(rpt);%通过漏洞创建一个循环周期。%内容附加到每个洞。而(~ strcmp (rpt.CurrentHoleId,“# #结束”))开关(rpt.CurrentHoleId)情况下“标题”追加(rpt,段(“这是我的名字”));情况下“作者”追加(rpt,“我的名字”);结束moveToNextHole (rpt);结束%生成并查看报告。关闭(rpt);rptview (rpt.OutputPath)

版本历史

介绍了R2014b

另请参阅

||

主题