mlreportgen.report.SectionTitle 类

命名空间: mlreportgen.report
超类: mlreportgen.report.Title

生成章节标题

描述

只有另一个报告（称为所有者）可以创建此类的实例。实例使用所有者通过实例模板指定的标题和其设置的实例属性来填补所有者指定的模板中的空位。例如，mlreportgen.report.Section 报告器（所有者）使用此类的实例，以分层编号的标题填充其模板中的 Title 空位。

该类的实例生成的标题由静态文本和动态内容组成。静态文本由实例模板指定。动态内容由实例 Content、NumberPrefix 和 NumberSuffix 属性指定。如果模板空位的名称与其中一个属性名称匹配，则此报告器将使用值属性填充该空位。例如，如果标题模板包含一个 Content 空位和一个 NumberPrefix 空位，则此报告器会使用相应属性的值填充这些空位。

所有者使用实例 TemplateSrc、TemplateName 和 OutlineLevel 属性指定标题模板的位置。TemplateSrc 属性指定模板库包含标题模板的模板文件的来源。TemplateName 属性指定标题模板的根名称。OutlineLevel 属性指定所有者生成的内容在报告层次结构中的级别。SectionTitle 实例将 OutlineLevel 属性的值追加到 TemplateName 属性的值以创建标题模板的全名。例如，Section 报告器模板库包含六个编号的标题模板，每个模板对应一个节级别。模板的名称为 SectionNumberedTemplate1、SectionNumberedTemplate2 等等。为了指定使用 SectionNumberedTemplate1 模板来生成章节标题，章节报告器将 SectionTitle TemplateName 属性设置为 SectionNumberedTemplate，并将 OutlineLevel 属性为 1。

如果设置了 SectionTitle LinkTarget 属性，则实例将在生成的标题前面带有具有指定目标 ID 的链接目标。

mlreportgen.report.SectionTitle 类是一个 handle 类。

属性

全部展开

`HoleId` — 所有者模板中的所有权空位名称
字符向量 | 字符串标量

所有者模板中的标题空位的名称，指定为字符向量或字符串标量。

`Content` — 标题文本
字符向量 | 字符串标量 | DOM 对象 | 1×N 或 N×1 字符串或 DOM 对象数组 | 1×N 或 N×1 字符串、字符向量和/或 DOM 对象的元胞数组 | ...

标题文本，指定为以下值之一：

字符串标量或字符向量
DOM 对象
1×N 或 N×1 字符串或 DOM 对象数组
1×N 或 N×1 字符串、字符向量和/或 DOM 对象的元胞数组

`NumberPrefix` — 标题中章节编号的前缀
字符向量 | 字符串标量

标题中章节编号的前缀，指定为字符向量或字符串标量。如果未指定前缀，则使用根据报告区域设置翻译的默认标题前缀。

`NumberSuffix` — 标题中章节编号的后缀
字符向量 | 字符串标量

标题中章节编号的后缀，指定为字符向量或字符串标量。如果未指定后缀，则使用根据报告区域设置翻译的默认标题后缀。

`Translations` — 章节标题前缀和后缀的翻译图
结构体

章节标题前缀和后缀的翻译映射，指定为 MATLAB^® 结构体。如果指定的翻译映射不包含报告语言环境的翻译，则 Translations 属性将使用 en 作为备份语言环境。有关有效语言环境的信息，请参阅 mlreportgen.report.Report 的 Locale 属性。

`OutlineLevel` — 所有者报告器的大纲级别
[1,6] 范围内的整数

报告节层次结构中所有者报告器的大纲级别，指定为 [1,6] 范围内的正整数。OutlineLevel 属性指定了所有者报告器生成的节在报告的节层次结构中的级别。SectionTitle 报告器将此属性的值追加到 TemplateName 属性的值以创建标题模板的全名。例如，如果 TemplateName 属性的值为 SectionNumberedTitle 且 OutlineLevel 属性的值为 2，则此报告器将生成 SectionNumberedTitle2 作为标题模板的全名。TemplateSrc 属性指定的模板库必须包含具有生成名称的模板。否则，就会发生错误。