主要内容

mlreportgen.report.SectionTitle类

包:mlreportgen.report
超类:

生成章节标题

描述

只有称为所有者的另一个报告才能创建该类的实例。实例用所有者通过实例模板和它设置的实例属性指定的标题来填充所有者指定的模板中的一个洞。例如,一个mlreportgen.report.Section报告器(所有者)使用该类的一个实例来填充标题在模板中插入一个有等级编号的标题。

该类实例生成的标题由静态文本和动态内容组成。静态文本由实例模板指定。动态内容由实例指定内容NumberPrefix,NumberSuffix属性。如果模板孔的名称与这些属性名称中的一个相匹配,该报告程序将使用value属性填充该孔。例如,如果标题模板包含内容孔和一个NumberPrefix洞,记者用相应属性的值填充这些洞。

所有者用实例指定标题模板的位置TemplateSrcTemplateName,OutlineLevel属性。的TemplateSrc属性指定模板文件的源,该模板文件的模板库包含标题模板。的TemplateName属性指定标题模板的根名称。的OutlineLevel属性指定由所有者生成的内容在报表层次结构中的级别。的SectionTitle的值追加OutlineLevel属性的值TemplateName属性创建标题模板的全名。例如,部分报告模板库包含六个编号的标题模板,每个都对应于一个节级别。模板的名称为SectionNumberedTemplate1SectionNumberedTemplate2,等等。指定…的使用SectionNumberedTemplate1模板来生成节标题,节报告器将设置SectionTitleTemplateName财产SectionNumberedTemplateOutlineLevel属性为1。

如果SectionTitleLinkTarget属性设置时,实例将位于生成的标题之前,该链接目标具有指定的目标ID。

属性

全部展开

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

标题文本,指定为以下值之一:

  • 字符串标量或字符向量

  • DOM对象

  • 1 -NN-by-1字符串或DOM对象数组

  • 1 -NN由字符串、字符数组和/或DOM对象组成的单元格数组

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

标题中的节号后缀,指定为字符串或字符数组。如果没有指定后缀,则使用默认标题后缀,该后缀根据报告区域设置翻译。

翻译映射为节标题的前缀和后缀,指定为MATLAB®结构。如果指定的翻译映射不包含报告区域设置的翻译,则翻译财产的使用作为备份区域设置。看到语言环境的属性mlreportgen.report.Report有关有效区域设置的信息。

在报表部分层次结构中,所有者报表的大纲级别,指定为范围[1,6]的正整数。的OutlineLevel属性指定报表的节层次结构中由所有者报告程序生成的节的级别。的SectionTitle属性的值附加此属性的值TemplateName属性创建标题模板的全名。例如,如果TemplateName属性是SectionNumberedTitle以及它的价值OutlineLevel属性为2,该报表生成SectionNumberedTitle2作为标题模板的全名。属性指定的模板库TemplateSrc属性必须包含具有生成名称的模板。否则,发生错误。

本文记者的模板来源,具体方式如下:

  • 指定包含此报告器模板的文件路径的字符向量或字符串标量

  • 该报表使用模板或模板库中包含该报表模板的报表或报表

  • DOM文档或文档部分,其模板用于此报表,或其模板库包含此报表的模板

指定的模板类型必须与该报表所附加的报表类型相同。例如,对于a微软®报告,TemplateSrc必须是Word记者模板。如果TemplateSrc属性为空时,报告程序将使用默认报告程序模板作为报告的输出类型。

模板根名称,指定为字符向量或字符串标量。该报告程序的模板位于模板源的模板库中(TemplateSrc)。

此报告器的超链接目标,指定为指定链接目标ID的字符向量或字符串标量,或mlreportgen.dom.LinkTarget对象。将字符向量或字符串标量值转换为LinkTarget对象。在输出报告中,链接目标紧跟在该报告的内容前面。

介绍了R2018b