DOM API 报告程序模板
DOM API 为每种输出类型都附带了默认模板,用于在生成报告时对其进行格式化。模板对于提供默认的设计格式很有用,这样您就不需要在报告中指定它们。如果多份报告看起来相同,这种方法会很有用,这在大多数组织中很常见。在报告程序中,您可以通过名称引用模板及其样式和布局。当您的报告生成时,模板决定了文档对象的外观。
模板还支持基于表单的文档生成。您可以在模板中定义固定内容和空位(空白占位)。您的报告程序可以用内容(例如文本或图像)填补空位。请参阅基于表单的报告。
使用模板的另一个优点是便于维护。如果报告设计发生变化,则只需更改模板,而无需更改使用该设计的所有程序。
使用模板还可以使您的报告程序更小,因为您不需要为创建的每个对象指定属性。对于数百页的报告,使用模板也可能提高性能。
您可以创建默认模板的副本并对其进行自定义,以指定报告的默认格式和布局。为了使模板生效,您的报告程序必须引用您的模板并指定要使用的样式名称和文档部件。
您可以使用 mlreportgen.dom.Document.createTemplate
方法创建默认模板的副本。默认模板可以作为您的模板的起点。
模板包
所有 DOM 模板(单文件 HTML 模板除外)均由根据开放打包约定 (OPC) 压缩到包中的文档、样式表和图像文件组成。单文件 HTML 模板将样式表和图像作为 HTML 元素嵌入 HTML 文档中。您可以使用 Microsoft® Word 直接编辑 Word 模板(由 .dotx
扩展名标识)。您还可以使用任何文本或 HTML 编辑器直接编辑单文件 HTML 模板。
要编辑多文件 HTML 模板(由 .htmtx
扩展名标识)和 PDF 模板(由 .pdftx
扩展名标识),您必须先解压缩它们。您可以选择在使用已编辑的 HTML 或 PDF 模板生成报告之前对其进行重新压缩。DOM API 提供了用于压缩和解压缩多文件 HTML 和 PDF 模板的函数:zipTemplate
和 unzipTemplate
。
样式
您可以使用模板中定义的样式来格式化段落、文本、表、列表等。您可以修改样式或者创建自己的样式。请参阅使用样式表样式。
Word 模板包括标准 Word 样式,例如 Normal、Heading 1 和 Title。您可以使用标准 Word 技术创建和修改样式。请参阅修改 Microsoft Word 模板中的样式。
HTML 和 PDF 模板使用以 .css
结尾的模板文件中的 CSS 属性定义样式。有关详细信息,请参阅 修改 HTML 模板中的样式 和 修改 PDF 模板中的样式
页面布局
您可以使用模板定义 Word 和 PDF 报告的页面布局,包括大小、方向(纵向或横向)、边距以及页眉和页脚。您可以使用模板为文档的不同节定义不同的页面布局。请参阅创建页面布局节。
您还可以通过编程来定义页面布局,或者使用通过编程和模板定义的布局组合。
文档部件模板
文档部件模板是报告中可重复结构体的模板。您可以使用 DocumentPart
对象从报告程序在报告中插入文档部件的实例。您可以在文档部件模板库中创建文档部件模板。
对于 Word 模板,您可以定义文档部件模板并将其存储在作为库的 Word 快速部件库中。默认模板不包含任何文档部件模板。要创建它们,请参阅 创建 Microsoft Word 文档部件模板库。
对于 HTML 和 PDF,默认模板包含一个名为 docpart_templates.html
的文档部件模板库文件。该文件创建库并包含一些默认的文档部件模板。您可以修改或删除提供的文档部件模板并添加您自己的模板。请参阅创建 HTML 文档部件模板库和创建 PDF 文档部件模板库。
另请参阅
unzipTemplate
| zipTemplate
| mlreportgen.dom.Document.createTemplate