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

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) 使用指定的引导符。

示例

输入参量

全部展开

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

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

属性

全部展开

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

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

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

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

示例

全部折叠

打开脚本

此示例使用 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);

提示

文档模板样式决定了此对象生成的 TOC 的大小、间距、颜色和其他格式属性。因此，您必须在文档模板中重新定义样式，而不是在包含该对象的文档部分所使用的模板中重新定义样式。要更改目录中条目的格式，请创建一个自定义文档模板，重新定义这些样式，并在生成文档时使用该模板。mlreportgen.dom.Document 对象的默认 Microsoft Word 和 PDF 模板包含目录中每个条目的默认样式。样式名称为 TOC1、TOC2、…、TOC6，其中样式 TOC1 定义第 1 级条目的格式，样式 TOC2 定义第 2 级条目的格式，依此类推。

版本历史记录

在 R2016a 中推出

另请参阅

| |

主题