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

mlreportgen.dom.OutlineLevel 类

命名空间: mlreportgen.dom

大纲中的段落级别

全页展开

描述

指定自动生成的大纲中的段落级别。此类适用于 Microsoft® Word 报告，因为 HTML 不支持在目录中显示段落。

此类仅与以下 MATLAB® Report Generator™ 输出类型兼容：

  • "docx"

  • "pdf"

  • "pdfa" (自 R2025a 起)

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

创建对象

描述

outlineLevelObj = OutlineLevel 将此段落的大纲级别设置为 1。这会导致段落的内容出现在自动生成的大纲（例如，目录）的顶层。

outlineLevelObj = OutlineLevel(level) 将段落设置为指定的大纲级别。

示例

输入参量

全部展开

段落的大纲级别，指定为正整数，从 1 到 9。

数据类型: int16

属性

全部展开

段落的大纲级别，指定为正整数，从 1 到 9。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: int32

标记，指定为字符向量或字符串标量。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

示例

全部折叠

打开脚本

添加自动生成的目录，并设置“词汇表”段落的大纲级别，以便该段落出现在目录的顶层。此示例使用默认的 DOM Word 模板。

为目录创建文档和文档部件。文档部件使用默认 DOM Word 模板中的 ReportTOC 构建模块。

import mlreportgen.dom.*
d = Document('tocDoc','docx');
open(d);

dp = DocumentPart(d,'ReportTOC');
append(d,dp);

内部设置 OutlineLevel 属性，使得目录有四个级别。

for i = 1:4
    % set internally the OutlineLevel property
    append(d,Heading(i,'My Chapter'));
    append(d,Paragraph('chapter content....'));
end

使用 OutlineLevel 将 Glossary 段落的级别设置为 1，以便该段落出现在目录的顶层。显示报告。

para = append(d,Paragraph('Glossary'));
para.Style = {OutlineLevel(1)};

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

版本历史记录

在 R2014b 中推出

另请参阅

|

主题