本页采用了机器翻译。点击此处可查看英文原文。

slreportgen.report.DocBlock 类

命名空间: slreportgen.report
超类: slreportgen.report.Reporter

DocBlock 报告器

全页展开

描述

使用 slreportgen.report.DocBlock 类的对象来报告 DocBlock 模块。

注意

要在报告中使用 DocBlock 报告器，您必须使用 slreportgen.report.Report 类或子类创建报告。

报告器通过以下方式之一将 DocBlock 内容纳入报告：

  • 包括报告中的实际内容

  • 将内容保存到外部文件并在报告中添加该文件的链接

  • 将内容作为文件嵌入到报告中，并添加嵌入式文件的链接

该表显示了报告器何时包含、链接或嵌入内容，具体取决于 DocBlock 内容类型、报告类型以及 ConvertHTML 和 EmbedFile 属性的值。

DocBlock 内容类型报告类型ConvertHTML 属性EmbedFile 属性报告包含
DocBlock 内容DocBlock 内容文件的外部链接嵌入式 DocBlock 内容文件的链接
文本HTML不适用不适用是否否
文本HTML 文件不适用不适用是否否
文本Word不适用不适用是否否
文本PDF不适用不适用是否否
HTMLHTML不适用不适用是否否
HTMLHTML 文件不适用不适用是否否
HTMLPDFtrue不适用是否否
HTMLPDFfalsetrue否否是
HTMLPDFfalsefalse否是否
HTMLWordtrue不适用是否否
HTMLWordfalse不适用否是否
RTFPDF不适用true否否是
RTFPDF不适用false否是否
RTFWord不适用不适用是否否
RTFHTML不适用true否否是
RTFHTML不适用false否是否
RTFHTML 文件不适用不适用否是否

注意

要取消链接包含 RTF 类型 DocBlock 的 Microsoft® Word 报告中的子文档，请使用带有 "unlinkdocxsubdoc" 和 "savedoc" 参量的函数 docview：

docview(docxReportFile,"unlinkdocxsubdoc","savedoc");

slreportgen.report.DocBlock 类是 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

rptr = slreportgen.report.DocBlock 根据默认模板创建一个空的 DocBlock 报告器。使用报告器属性自定义生成内容的内容和格式。在将报告器添加到报告之前，您必须指定报告器的 Object 属性中的 DocBlock。在报告中添加空的报告器会产生错误。

rptr = slreportgen.report.DocBlock(docBlockObj) 为 docBlockObj 指定的 DocBlock 创建一个 DocBlock 报告器，它可以是 DocBlock 路径或句柄。请参阅 Object 属性。

示例

rptr = slreportgen.report.DocBlock(Name=Value) 使用名称-值参量设置报告器属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

Simulink DocBlock 模块，指定为包含 DocBlock 路径的字符向量或字符串标量，或 DocBlock 模块的句柄。

注意

如果您使用查找器查找 DocBlock 模块并将结果直接添加到报告中，则使用 DocBlock 报告器来报告 DocBlock 模块，而不是 Simulink 对象属性报告器。

是否以行形式导入纯文本内容，指定为 true 或 false。如果 ImportTextInline 是 false，则在报告器将内容附加到洞之前，它会将内容包装在一个或多个段落中，具体取决于 TexSep 属性的值。将 ImportTextInline 设置为 true 以将 DocBlock 文本内容附加到段落中的空洞（内联空洞）。

用于分隔纯文本内容中的段落的分隔符，指定为以下值之一：

值描述
"Ignore"无论文本是否包含分隔符，都将文本换行放在一个段落中。（默认）
"LineFeed"如果文本段以换行符结束，则将其换入段落。
"BlankLine"如果文本段以空行结束，则将其换成段落。

是否包含 HTML 内容，指定为 true 或 false。属性仅适用于 Word 和 PDF 报告。

如果值为 true，则 HTML 内容将转换为 DOM 对象并附加到报告中。

如果值为 false：

  • 对于 PDF 报告，报告嵌入内容或包含指向内容的外部链接，具体取决于 EmbedFile 属性的值。

  • 对于 Word 报告，报告包含指向内容的外部链接。

如果报告是 HTML 或 HTML 文件报告，则 HTML 内容将包含在报告中，无论 ConvertHTML 属性的值是什么。

是否在生成的报告中嵌入 DocBlock 模块的内容，指定为 true 或 false。此属性仅适用于 PDF 报告的 HTML 或 RTF 内容以及 HTML 报告的 RTF 内容。如果值为 true，报告器会在报告中嵌入 DocBlock 内容，并插入嵌入文件的超链接。

如果 ImportTextInline 属性为 false，则段落格式化程序对象会格式化纯文本，指定为 mlreportgen.dom.Paragraph 对象。ParagraphFormatter 属性的初始值是一个具有默认属性值的 mlreportgen.dom.Paragraph 对象。要自定义段落的外观，请修改 mlreportgen.dom.Paragraph 对象属性或将该对象替换为自定义的 mlreportgen.dom.Paragraph 对象。如果向默认或替换段落对象添加内容，则该内容会出现在生成的报告中的 DocBlock 内容前面。

如果 ImportTextInline 属性为 true，则文本格式化程序对象会格式化纯文本，指定为 mlreportgen.dom.Text 对象。TextFormatter 属性的初始值是一个具有默认属性值的 mlreportgen.dom.Text 对象。要自定义文本的外观，请修改 mlreportgen.dom.Text 对象属性或将该对象替换为自定义的 mlreportgen.dom.Text 对象。如果向默认或替换段落对象添加内容，则该内容会出现在生成的报告中的 DocBlock 内容前面。

此报告器的模板来源，以下列方式之一指定：

  • 字符向量或字符串标量，指定包含此报告器模板的文件的路径

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。此报告器的模板必须位于此报告器 TemplateSrc 属性所指定模板的模板库中。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标紧接在输出报告中此报告器的内容之前。

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

通过向报告中添加 Sensor Info 报告器，将 sldemo_fuelsys 模型的 DocBlock DocBlock 中的内容包含在报告中。指定 DocBlock 中的段落以换行符分隔。

导入 API 命名空间，这样您就不必使用长而完全限定的名称。

import slreportgen.report.*
import mlreportgen.report.*

加载模型。

model_name = "sldemo_fuelsys";
load_system(model_name);
docBlock = "sldemo_fuelsys/To Controller/Sensor Info";

创建报告。

rpt = slreportgen.report.Report("output","pdf");

创建章节报告器。

chapter = Chapter(docBlock);

创建一个 DocBlock 报告器。指定段落以换行符分隔。

rptr = DocBlock(docBlock);
rptr.TextSep = "LineFeed";

将 DocBlock 报告器添加到章节中，并将章节添加到报告中。

add(chapter, rptr);
add(rpt, chapter);

关闭并查看输出报告。

close(rpt);
close_system(model_name);
rptview(rpt);

生成的报告从 Sensor Info DocBlock 中显示以下内容：

Generated report displaying measurement descritions for Throttle Angle, Engine Speed, Ego Sensor, and MAnifold Pressure from the Sensor Info DocBlock.

版本历史记录

在 R2019b 中推出

另请参阅

| |

主题