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

mlreportgen.report.TextFile 类

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

文本文件报告器

自 R2023a 起

全页展开

描述

创建一个报告器来报告文本文件。

mlreportgen.report.TextFile 类是一个 handle 类。

类属性

HandleCompatible
true

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

创建对象

描述

reporter = TextFile 根据默认模板创建一个空的 TextFile 报告对象。使用其属性来指定要报告的文本文件并指定报告选项。您必须指定要报告的文本文件名。向报告中添加一个空的 TextFile 报告对象（即未指定文件名的对象）会产生错误。

reporter = TextFile(filename) 创建一个 TextFile 报告器对象，并将 FileName 属性设置为 filename。将此报告器添加到报告中，无需任何进一步的修改，将文本文件内容添加到生成的报告中。使用报告器的属性来自定义报告选项。

reporter = TextFile(p1,v1,p2,v2,...) 创建一个 TextFile 报告器并将属性 (p1,p2,...) 初始化为指定值 (v1,v2,...)。

示例

属性

全部展开

文本文件的路径或名称，指定为字符向量或字符串标量。

示例: tf.FileName = "Name of File"

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

指定是否将文件作为 DOM Paragraph 或 DOM Text 对象导入。当设置为 true 时，MATLAB® 会将文件作为 DOM Paragraph 对象导入。输入按照 ParaSep 属性设置的值分成段落。使用值为 DOM Paragraph 对象的 ParagraphFormatter 属性来格式化 DOM Paragraph 对象。如果该属性设置为 false，MATLAB 会将文本文件导入为 DOM Text 对象。使用值为 DOM Text 对象的 TextFormatter 属性来格式化 DOM Text 对象。

示例: "ImportFileAsParagraph","false"

属性：

GetAccess
public
SetAccess
public

数据类型: logical

段落分隔符，指定为字符向量或字符串标量。使用此属性指定用于将输入分成段落的分隔符。您可以使用任意分隔符。例如，newline 在换行符处分隔输入文本，并将文本换行成段落。

示例: "ParaSep","char(10)"

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

如果 ImportFileAsParagraph 报告器的 TextFile 属性为 true，则报告器会将纯文本段落追加到此对象的副本之后，再将其追加到报告中。使用 mlreportgen.dom.Paragraph 对象属性通过设置默认段落的属性或用自定义段落替换默认段落来格式化纯文本段落。您添加到默认或替换段落的内容将显示在生成的报告内容之前。

示例: "ParagraphFormatter.Color","red"

属性：

GetAccess
public
SetAccess
public

如果 ImportFileAsParagraph 报告器的 TextFile 属性为 false，则报告器会将纯文本内容追加到此对象的副本之后，再将其追加到报告中。使用 mlreportgen.dom.Text 对象属性来格式化纯文本内容。您添加到默认值的内容会出现在生成的报告内容之前。

示例: "TextFormatter.Color","red"

属性：

GetAccess
public
SetAccess
public

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

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

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

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

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

从文本文件创建一份段落报告。

首先，创建一个文本文件并将其保存为 my_script.txt 以供本示例使用。接下来，导入报告 API 命名空间，这样您就不必使用长的完全限定类名。

import mlreportgen.report.*

创建 PFD 报告。

rpt = Report("MyReport","pdf");
open(rpt);

创建一个空白章节。

chap = Chapter("TextFile Reporter");

创建一个 TextFile 报告器。指定段落分隔符，以便报告在每个换行符处创建一个新段落。

rptr = TextFile("my_script.txt");
rpt.ParaSep = [newline newline];

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

append(chap,rptr);
append(rpt,chap);

关闭并查看报告。

close(rpt);
rptview(rpt);

版本历史记录

在 R2023a 中推出