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

mlreportgen.dom.RawText 类

R2026b

命名空间: mlreportgen.dom

在文档中插入 HTML、Microsoft Word XML 或 PDF 格式化对象标记

全页展开

描述

使用 mlreportgen.dom.RawText 类的实例在文档中插入 HTML、Microsoft® Word XML 标记或 PDF 格式化对象标记。

要了解可以将 mlreportgen.dom.RawText 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.RawText 对象追加到 DOM 类对象上。

mlreportgen.dom.RawText 类是一个 handle 类。

创建对象

描述

text = RawText 创建一个空 RawText 对象。

您只能将 RawText 对象追加到 Document 对象。

text = RawText(htmlMarkup) 创建一个包含指定 HTML 标记的 RawText 对象。

示例

text = RawText(markup,doctype) 会创建一个名为 RawText 的容器，其中包含指定文档类型的标记。

输入参量

全部展开

HTML 标记，指定为字符向量或字符串标量。htmlMarkup 指定属性 HTMLText。该标记必须是有效的 HTML 标记，能够正确地插入到 HTML 输出文档的 body 元素中。如果在 HTML 文档中插入无效的标记，该文档可能无法正确显示。为了提高报告文档的可读性，请考虑将标记分配给变量。然后使用该变量作为输入参量，如下例所示。

HTML 标记、Word XML 标记或 PDF 格式化对象，指定为字符向量或字符串标量。如果 doctype 是：

  • "html" - markup 指定属性 HTMLText。该标记必须是有效的 HTML 标记，能够正确地插入到 HTML 输出文档的 body 元素中。如果在 HTML 文档中插入无效的标记，该文档可能无法正确显示。

  • "docx" - markup 指定属性 DOCXText。该标记必须是有效的 Word XML 标记，能够正确插入到 Microsoft Word 输出文档的 w:body 元素中。如果在 Microsoft Word 文档中插入无效标记，Word 可能无法打开该文档。

  • "pdf" - markup 指定属性 PDFText。此属性的值必须是有效的格式化对象 (FO) 标记，该标记可插入到 PDF 输出文档的 FO 表示形式中的 fo:flow、fo:block 或 fo:table-cell 元素中。如果在 PDF 文档中插入无效的 FO 对象，该文档可能无法正确显示。

为了提高报告文档的可读性，请考虑将标记分配给变量。然后使用该变量作为输入参量，如下例所示。

要使用的标记类型，指定为字符向量或字符串标量。

属性

全部展开

输出到 Word 文档的 Word XML 标记文本，指定为字符向量或字符串标量。如果文档的类型为 "docx"，则包含此属性的值。该标记必须是有效的 Word XML 标记，可以插入到 Word 文档的 w:body、w:p 或 w:tc 元素中。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

输出到 HTML 文档的 HTML 标记文本，指定为字符向量或字符串标量。如果文档的类型为 "html"、"html-file" 或 "html-multipage"，则包含此属性的值。文本必须是有效的 HTML 标记，可以插入到 HTML 文档的 body、p 或 td 元素中。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

格式化对象标记以输出到 PDF 文档，指定为字符向量或字符串标量。如果文档的类型为 "pdf" 或 "pdfa" (自 R2025a 起)，则包含此属性的值。此属性的值必须是有效的格式化对象 (FO) 标记，可以插入到 PDF 文档内容的 FO 表示的 fo:flow、fo:block 或 fo:table-cell 元素中。有关 FO 的更多信息，请参阅 https://www.w3.org/TR/xsl11/。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

示例

全部折叠

将 HTML 标记分配给变量并使用该变量创建 RawText 对象以追加到文档。

import mlreportgen.dom.*;
d = Document("test","html");

script = "<script>" + ...
   "document.write(""Hello World!"")" + ...
   "</script>";
append(d,RawText(script));

close(d);
rptview("test","html");

详细信息

全部展开

版本历史记录

在 R2014b 中推出

另请参阅

主题