主要内容

mlreportgen.dom.Template类

包:mlreportgen.dom
超类:

创建报告模板对象

描述

创建报表模板对象。

使用mlreportgen.dom.Template对象来创建模板。例如,您可以附加DOM内容,例如文本段落, 或者图像对象,TemplateHole对象到A.模板对象创建一个模板,该模板包含固定内容,生成的内容有孔。

请注意

Mac Word不支持为DOM API模板创万博1manbetx建孔。如果需要创建用于在Mac上生成Word文档的Word模板,则可以使用DOM API创建模板。创建一个模板对象和使用mlreportgen.dom.TemplateHole增加孔。或者,在Windows上使用Word®创建模板并将模板复制到Mac。

建造

templateObj=模板()创建一个基于默认HTML模板的模板对象。结果模板在当前文件夹中,并使用该名称Untitled.htmtx

附加内容并使用相应的内容关闭命令生成模板文件。

templateObj=模板(模板路径创建在指定位置输出模板文件的模板对象。如果没有指定扩展名,默认模板类型是HTML。

templateObj=模板(模板路径类型创建指定类型的模板。如果您指定了分机使用模板路径,类型必须匹配。

提示

的变量类型参数来简化代码。看到创建模板并添加内容例如,

templateObj=模板(模板路径类型sourceTemplatePath基于模板创建模板sourceTemplatePath

输入参数

展开全部

要创建的模板的完整路径,指定为字符向量。你可以使用一个扩展来创建相应类型的模板:

  • .htmtxHTML(默认)

  • .docx.

  • .htmt.对于单文件HTML

  • .pdf.对于PDF

模板的类型,指定为以下值之一:

  • 'html'- HTML模板是一个压缩或解压缩的文件夹,包含HTML文档文本、图像、样式表和JavaScript®文件

  • 'docx'- Word模板

  • 'html-file'- HTML模板组成一个单一的文件,包含文本,样式表,JavaScript,和图像的报告

  • .pdf.- - - - - - PDF模板

如果您使用扩展模板路径输入参数,类型参数必须匹配。

模板,它是新模板的基础,指定为字符向量。源模板类型必须匹配类型论点。

输出参数

展开全部

创建模板,返回为mlreportgen.dom.Template目的。

特性

展开全部

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

这个只读属性是本文档中当前孔的孔ID。

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

  • 内联孔用于段落元素可以包含的文档元素:文本图像LinkTargetExternalLinkInternalLink陈特齐自动数量

  • 一个阻塞孔可以包含一个段落表格OrderedListUnorderedListDocumentPart., 或者团体

此属性适用于Word和PDF文档。对于Word文档,值是一个docxpagelayout.对象指定当前页面布局。对于PDF文档,值为aPDFPageLayout对象如果文档当前指定页面布局。对于HTML文档,值始终是[]。

将此属性设置为真正的覆盖相同名称的现有输出文件。如果这个属性是并存在相同名称的可写文件,尝试关闭(即,写)此模板会导致错误。如果现有文件是只读的,则关闭此文档会导致错误,无论此属性的设置如何。

数据类型:逻辑

HTML标题的自定义内容,指定为字符向量。

数据类型:字符

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

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

输出文件或文件夹的路径指定为字符向量。如果未指定文件扩展名,则DOM根据文档格式添加扩展名。您只能在打开文档之前设置此属性。

对于解压后的输出打包,路径指定输出文件的文件夹。默认是当前文件夹。

包装用于生成的输出文件,指定为其中一个值:

  • '拉链'—仅支持Word、PDF和多文件HTML输出。

  • '解压缩'—仅支持Word、PDF和多文件HTML输出。

  • “两个”—仅支持Word、PDF和多文件HTML输出。

  • '单一文件'—将报表创建为单个文件。如果您设置了文档的类型财产'html-file'.您不能自己设置或更改此值。

对于压缩包装,文档输出是位于指定位置的zip文件输出路径财产。zip文件具有与文档类型匹配的扩展名:docx.字输出,pdftx用于PDF输出,或htmtx.用于HTML输出。例如,如果文档类型是docx.输出路径s: \ docs \ MyDoc,输出被打包在一个名为s: \ docs \ MyDoc.docx

对于解压缩的包装,文档输出存储在具有根文件名的文件夹中输出路径财产。例如,如果输出路径s: \ docs \ MyDoc,则输出文件夹为s: \ docs \ MyDoc

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

数据类型:字符

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

数据类型:逻辑

标识此文档的标签。标签具有表单类:ID, 在哪里班级是文件类和ID是值的价值Id对象的属性。

指定自己标记值的一个原因是为了更容易地确定文档生成过程中哪里发生了问题。

要使用的HTML或Word模板的完整路径,指定为字符向量。

对于HTML文档,此属性指定用于显示此文档的浏览器标题栏中显示的文本。Word和PDF文件忽略此属性。

打开文档以进行输出之前设置此属性。

输出类型,指定为以下值之一:

  • 'html'- HTML输出为压缩或解压缩文件夹,包含HTML文档文本、图像、样式表和JavaScript文件

  • 'docx'- 单词输出

  • 'html-file'- 由包含文本,样式表,JavaScript和图像的单个文件组成的HTML输出

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

方法指定模板TemplatePath属性,模板必须与之一致类型财产。

方法

使用模板方法使用相应的方式相同文档方法。

方法

目的

附加

将文档元素附加到文档。

关闭

关闭这个文件。如果文档尚未打开或以前关闭过,则无法关闭该文档。

mlreportgen.dom.Document.createTemplate

创建默认模板。

填满

填写文件孔。

mlreportgen.dom.Document.getCoreProperties

获取文档的核心属性。

mlreportgen.dom.document.getimageageTirectory.

获取文档的图像目录。

mlreportgen.dom.Document.getImagePrefix

获取文档生成的图像名称前缀。

getmainpartpath.

获取输出文档主要部分的相对路径。

mlreportgen.dom.Document.getOPCMainPart

获取输出文档主要部分的完整路径。

movetonexthole.

移动到下一个模板孔。

打开

打开这个文件。如果文档之前已打开或关闭,则无法打开该文档。

追加文件到OPC包的文件。

mlreportgen.dom.Document.setCoreProperties

设置文档元素的核心属性。

例子

全部折叠

这个例子创建了一个模板,其中有一个洞用于标题,一个洞用于作者。的值类型变量来创建其他类型之一的模板。

进口mlreportgen.dom。*;类型='docx'%创建模板对象t =模板('mytemplate'、类型);%为模板添加标题孔并应用标题样式洞= append (t, TemplateHole (“标题”));HOOL.Description =(的标题描述);洞。DefaultHoleStyleName =“标题”%添加了一个带有样板文本的段落,并应用字幕格式%定位段落并在文本中保留空白空间p =段落(的作者:);p.StyleName ='字幕';p.style = {utermargin(' 0 '' 0 '“1”“1”)};p.WhiteSpace ='保存'在段落中附加一个内联孔洞= append (p, TemplateHole ('作者'));附录(t,p);壁橱);

本例使用模板来填补这些漏洞。

创建一个使用模板mytemplate的文档TitleAuthor。RPT =文件(“TitleAuthor”,类型,'mytemplate');打开(rpt);创造一个循环通过孔。%附加到每个孔的内容。(~ strcmp (rpt。火山岩,“# #结束”))转变(rpt.currentholeid)案件“标题”附录(RPT,段落(“这是我的头衔”));案件'作者'附录(RPT,“我的名字”);结束movetonexthole(RPT);结束%生成并查看报表。关闭(rpt);rptview (rpt.OutputPath)