主要内容

mlreportgen.dom.DocumentPart类

包:mlreportgen.dom
超类:

创建文档部件对象

描述

定义文档部分,报表的可重复部分。文档部分通常有您在生成报告期间填充的漏洞。可以将部分追加到文档中,也可以追加到具有相同输出类型的文档部分中。

建设

documentPartObj= DocumentPart ()使用默认的HTML模板创建HTML文档部分。

documentPart= DocumentPart (类型创建指定类型的文档部分(例如,微软®),基于该部件的默认模板。

documentPartObj= DocumentPart (类型templatePath基于指定的模板创建文档部件。

documentPartObj= DocumentPart (类型templatePathdocPartTemplateName基于指定模板中的指定文档部件模板创建文档部件。

documentPartObj= DocumentPart (templateSrcdocPartTemplateName基于存储在指定源使用的模板中的指定文档部件模板创建文档部件。源可以是一个文档,也可以是文档的一部分。

输入参数

全部展开

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

  • “html”——HTML输出

  • “pdf”—PDF格式,基于PDF模板

  • “多克斯”字的输出

  • html文件的- HTML输出,使用单个文件,其中包含CSS, JavaScript®,以及报告的图像

属性指定的模板templatePath参数的值类型必须与模板类型匹配。

此部分模板文件或文件夹的完整路径,指定为字符向量。如果省略文件扩展名,则模板类型基于文档类型,例如,。docx的词。

数据类型:字符

文档部分模板名称,指定为字符向量。控件指定部件存储的位置templatePathtemplateSrc论点。

文档或文档部件对象,其模板包含该文档部件的模板,指定为mlreportgen.dom.Document对象或文档的mlreportgen.dom.DocumentPart对象的。

输出参数

全部展开

文档部分,返回为mlreportgen.dom.DocumentPart对象。

属性

全部展开

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

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

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

  • inline hole用于段落元素可以包含的文档元素:文本图像LinkTargetExternalLinkInternalLinkCharEntityAutoNumber

  • 一个块孔可以包含一个表格OrderedListUnorderedListDocumentPart,或集团

此属性适用于Word和PDF文档。对于Word文档,值为aDOCXPageLayout对象,该对象指定当前页面布局。对于PDF文档,值为aPDFPageLayout对象,如果文档当前指定了页面布局。对于HTML文档,值总是[]。

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

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

此文档元素的父元素,指定为一个DOM对象。此属性是只读的。

此文档元素的标记,指定为字符向量或字符串标量。

DOM生成一个会话唯一的标记,作为创建该对象的一部分。生成的标记具有CLASS:ID形式,其中CLASS是对象类,ID是Id对象的属性。指定自己的标记值可以帮助您确定在文档生成期间问题发生的位置。

如果该模板存储在由该部件指定的模板的文档部件模板库中,则该部件模板的名称TemplatePath财产。属性指定的模板TemplatePath属性用作该部分的模板。

该部分模板或其模板库包含该部分模板的模板的路径,指定为字符向量。

输出类型,指定为这些值之一。

  • “HTML”- HTML报告打包成一个压缩文件,包含报告的HTML文件、图像、样式表和JavaScript文件。

  • html文件的- HTML报告作为一个单独的HTML文件,包含文本、样式表、JavaScript和base64编码的报告图像

  • “PDF”- - - - - - PDF文件

  • “多克斯”- - - - - -微软文字处理软件文档

属性指定的模板TemplatePath属性的值类型必须与模板类型匹配。

方法

使用DocumentPart方法就像你使用相应的文档方法。

方法

目的

addHTML

使用DocumentPart.addHTML和你使用的方法相似Document.addHTML

附加HTML文本到文档

addHTMLFile

使用DocumentPart.addHTMLFile和你使用的方法相似Document.addHTMLFile

附加HTML文件内容到文档

附加

将document元素附加到文档部分。

关闭

关闭此文档部分。如果文档部件尚未打开或先前已关闭,则不能关闭该文档部件。

mlreportgen.dom.Document.createTemplate

创建文档部件模板。

填满

孔填充文档。

mlreportgen.dom.Document.getCoreProperties

获取文档部件的核心属性。

mlreportgen.dom.Document.getOPCMainPart

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

moveToNextHole

移动到下一个模板孔。

开放

打开此文档部分。如果文档部分之前已打开或关闭,则无法打开该文档部分。如果文档部件的库源代码已关闭,则无法打开该文档部件。

mlreportgen.dom.Document.setCoreProperties

设置文档部件的核心属性。

例子

全部折叠

这个例子创建了一个函数createMagicParts基于空白文档部件模板定义文档部件的。新文档部分有一个标题,其文本取决于输入。生成的每个文档部件都包含一个魔术方表,它的外观也是基于输入的。这个例子创建了一个包含函数magicparts它根据输入迭代地将文档部分追加到报告中。

创建函数。

函数magic_square_report (square_sizes report_type)%MAGIC_SQUARE_REPORT魔方报告% magic_square_report (square_sizes report_type)%创建指定输出类型的报告% (docx, pdf,或html)的指定魔术%的方块。例如,创建一个PDF报告%大小为5、10和15的正方形,输入以下内容%行在MATLAB命令行:% magic_square_report ([5 10 15], pdf);进口mlreportgen.dom。*;rpt =文档(“MagicSquareReport”, report_type);打开(rpt);I = 1:length(square_sizes) sz = square_sizes(I);节= createSquareSection (rpt, sz);追加(rpt,部分);结束关闭(rpt);rptview (rpt.OutputPath);函数section = createSquareSection(rpt,square_size) importmlreportgen.dom。*%创建文档部分来保存section节= DocumentPart (rpt.Type);%创建魔术正方形标题h1 = Heading1 (sprintf (“魔(% i)”square_size));把每个方格放在单独的一页上。h1。风格= {PageBreakBefore(真正)};追加(部分中,h1);%创建保存正方形的表table = append(section, table (magic(square_size)));%格式表表格边境=“固体”;表格ColSep =“固体”;表格RowSep =“固体”

调用该函数生成报告。更改输入参数以更改内容或输出格式。这个例子创建了一个包含三个方块的Word文档。

magic_square_report([5、8、12),“多克斯”);