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

mlreportgen.dom.Container 类

命名空间: mlreportgen.dom

文档对象的容器

全页展开

描述

创建一个容器元素。使用 mlreportgen.dom.Container.append 方法将文档元素追加到容器。使用报告中的 mlreportgen.dom.Container 对象将格式应用于容器的所有子项。

在 HTML 输出中，Container 对象生成由其 HTMLTag 属性指定类型的 HTML 元素，并包含与其文档对象模型 (DOM) 内容相对应的 HTML 元素。例如，具有 Container 属性 HTMLTag 且包含文本 div 的 Hello World 对象会生成以下标记：

<div><p><span>Hello World</span></p></div>

生成的 HTML 容器元素分别具有由 Container 对象 StyleName 和 Style 属性指定的 class 和 style 属性。HTML CSS 格式继承规则确保 Container 对象生成的子对象继承 Container 对象 Style 和 StyleName 属性指定的格式。例如，如果 Container 对象指定红色作为其文本颜色并且其文本子项均未指定颜色，则文本子项将被涂成红色。

对于 Microsoft® Word 和 PDF 报告输出，Container 对象仿真容器格式继承，将 Container 对象 Style 属性指定的格式应用于每个子项（除非被子项覆盖），然后将子项追加到输出。Word 和 PDF 输出忽略 HTMLTag 对象的 StyleName 和 Container 属性。

提示

您可以使用 mlreportgen.dom.Container 或 mlreportgen.dom.Group 对象来生成文档元素的集合。

  • 使用容器对象将格式继承应用于一组对象，并创建 DOM 不支持的 HTML 容器元素，例如 div、section 和 article。

  • 使用组对象将相同的内容追加到文档的多个位置，而无需克隆该组。

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

类属性

HandleCompatible
true
ConstructOnLoad
true

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

创建对象

描述

containerObj = Container 创建一个带有 HTML 标记名 div 的容器。

containerObj = Container(HTMLtag) 创建一个具有指定 HTML 标记名称的容器（例如，div、section 或 article）。

示例

输入参量

全部展开

HTML 容器标记名称，指定为字符向量或字符串标量。该名称必须是 HTML 元素，例如 "div"、"section" 或 "article"。

注意

Word 输出忽略 HTML 容器标记。

输出参量

全部展开

文档对象的容器，以 mlreportgen.dom.Container 对象的形式返回。

属性

全部展开

容器的 HTML 标记名称，指定为字符向量或字符串标量。该名称必须是 HTML 元素，例如 "div"、"section" 或 "article"。

注意

Microsoft Word 输出忽略 HTML 标记名称。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

样式表中定义的样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观，除非该元素的 Style 属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息，请参阅 使用样式表样式。

注意

Microsoft Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此文档元素对象的格式规范，指定为 DOM 格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

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

方法

全部展开

示例

全部折叠

打开脚本

创建一个容器对象。Word 输出忽略 HTML 容器元素标记（在此示例中为 div 标记）。

import mlreportgen.dom.*;
rpt = Document('MyReport','docx');

c = Container();

将容器内的所有文本都涂成红色。

c.Style = {Color('red')};

将内容追加到容器并将容器追加到报告。

append(c,Paragraph('Hello'));
append(c,Table(magic(5)));
append(rpt,c);

关闭并生成报告。

close(rpt);
rptview(rpt.OutputPath);

版本历史记录

在 R2015a 中推出

另请参阅

主题