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

mlreportgen.report.Title 类

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

填补标题空位报告器

全页展开

描述

其他报告器（例如 Chapter、FormalImage 和 BaseTable）用来填补模板中的标题空位的报告器。

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

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

所有者通过实例 TemplateSrc 和 TemplateName 属性指定标题模板的位置。TemplateSrc 属性指定模板库包含标题模板的模板文件的来源。TemplateName 属性指定标题模板的名称。例如，BaseTable 报告器模板库包含两个编号标题模板，一个名为 BaseTableNumberedTitle（用于编号表），一个名为 BaseTableHierNumberedTitle（用于分层编号表）。BaseTable 报告器通过将此报告器的 TemplateSrc 属性设置为 BaseTable 模板，并将此报告器的 TemplateName 属性设置为标题模板名称来指定使用哪个模板。

所有者还可以通过将此报告器的 LinkTarget 属性设置为链接目标的 id，在标题前面生成超链接目标。

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

属性

全部展开

该报告器要填充的孔的名称，指定为字符向量或字符串标量。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

该报告器要填补的空位内容，指定为以下值之一：

  • 字符串或字符数组

  • DOM 对象

  • 1×N 或 N×1 字符串或 DOM 对象数组

  • 由字符串、字符数组和/或 DOM 对象组成的 1×N 或 N×1 元胞数组

属性：

GetAccess
public
SetAccess
public

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

标题翻译，指定为 MATLAB® 结构体。该结构体包含三个字段，默认情况下为空：

  • Translations.NumberPrefixSuffix

    如果此字段为空（默认值），则不会翻译标题编号前缀和后缀。为了生成标题编号前缀和后缀的本地化版本，标题所有者将此字段设置为 MATLAB containers.MAP 对象，该对象将语言环境键映射到包含 NumberPrefix 和 Numbersuffix 属性的翻译的结构体。值结构体必须包含以下字段：

    • Locale - 语言环境 ID，例如 "en"

    • TitleNumberPrefix - 特定于语言环境的数字前缀，例如 "Chapter"

    • TitleNumberSuffix - 特定于语言环境的数字后缀，例如 ". "

  • Translations.Content

    如果此字段为空（默认值），则不翻译标题内容。为了生成标题内容的本地化版本，标题报告器所有者将此字段设置为 MATLAB containers.Map 对象，该对象将语言环境键映射到标题内容的翻译。如果该字段的值不为空，并且此报告器的 Content 属性的值为空，则此报告器使用内容映射来查找标题内容的本地化版本。

  • Translations.Owner

    此属性用于查找标题所有者报告器指定的默认标题内容翻译。此属性仅供内部使用。

如果指定的翻译映射不包含指定报告语言环境的翻译，则使用 en 语言环境作为标题、前缀和后缀的语言环境。有关有效语言环境的信息，请参阅 mlreportgen.report.Report 的 Locale 属性。

属性：

GetAccess
public
SetAccess
public

数据类型: struct

该报告器的模板来源，以下列方式之一指定：

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

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的 TemplateSrc 属性指定的模板的模板库中。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

版本历史记录

在 R2018b 中推出

另请参阅

|

主题