Main Content

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

mlreportgen.dom.TOC 类

命名空间: mlreportgen.dom

创建用于生成目录的占位符

全页展开

描述

为文档目录创建占位符。当生成的 Word 文档打开时，Word 会用其生成的目录替换占位符。类似地，当生成的 HTML 文档在 HTML 浏览器中打开时，浏览器会用其生成的目录替换占位符。对于 PDF，DOM API 用其在输出文档时生成的 TOC 替换占位符。

在所有情况下，目录条目均由使用您指定的标题级别数的段落内容组成。对于 PDF 和 Word，目录占位符还指定一个引导符，用于填充目录条目中的内容和页码之间的空格。

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

创建对象

描述

toc = TOC 生成使用点引导符的三级目录。

toc = TOC(levels) 使用指定数量的标题级别。

toc = TOC(levels,leader) 使用指定的引导符。

示例

输入参量

全部展开

目录中使用的标题级别数，指定为正整数。

标题和页码之间使用的引导符类型，指定为 '.'（即句点或点）或 ' '（空格）。

属性

全部展开

标题和页码之间使用的引导符类型，指定为 '.'（即句点或点）或 ' '（空格）。

目录中使用的标题级别数，指定为正整数。

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

属性：

NonCopyable
true

数据类型: cell

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

注意

Microsoft® Word 输 出忽略样式名称。

属性：

NonCopyable
true

数据类型: char | string

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable
true

mlreportgen.dom.TOC 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

SetAccess
private
NonCopyable
true

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

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.TOC 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.TOC 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable
true

数据类型: char | string

示例

全部折叠

打开脚本

此示例使用 TOC 对象向文档添加目录。本文档包含三个级别的标题--|Heading1|、Heading2 和 Heading3。由于 TOC 对象仅指定两个标题级别，因此 Heading3 不包含在目录中。引导符是一个空格。

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

title = append(d, Paragraph('My TOC Document'));
title.Bold = true;
title.FontSize = '28pt';

toc = append(d,TOC(2,' '));
toc.Style = {PageBreakBefore(true)};

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
h2.Style = {PageBreakBefore(true)};
p2 = append(d,Paragraph('Another page'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d, Paragraph('My Level 3 Heading Text'));

close(d);
rptview(d.OutputPath);

版本历史记录

在 R2016a 中推出

另请参阅

| |

主题