mlreportgen.report.Title class

Пакет: mlreportgen.report
Суперклассы:

Заполните генератор отчетов отверстия заголовка

расширьте все на странице

Описание

Генератор отчетов, что другие генераторы отчетов, такие как Chapter, FormalImage, и BaseTable, используйте, чтобы заполнить отверстие заголовка в шаблоне.

Экземпляр этого класса может быть создан только другим генератором отчетов, который называется владельцем. Экземпляр заполняет отверстие в шаблоне, что владелец указывает с заголовком, что владелец указывает через шаблон экземпляра и свойства экземпляра, что он устанавливает. Например, BaseTable генератор отчетов (владелец) использует экземпляр этого класса, чтобы заполнить отверстие Заголовка в его шаблоне с иерархически пронумерованным заголовком.

Заголовок, сгенерированный экземпляром этого класса, состоит из статического текста и динамического контента. Статический текст задан шаблоном экземпляра. Динамический контент задан экземпляром Content, NumberPrefix, и NumberSuffix свойства. Если имя отверстия шаблона совпадает с одним из этих имен свойства, этот генератор отчетов заполняет отверстие свойством значения. Например, если шаблон заголовка содержит Content отверстие и NumberPrefix отверстие, этот генератор отчетов заполняет те отверстия значениями соответствующих свойств.

Владелец задает местоположение шаблона заголовка через экземпляр TemplateSrc и TemplateName свойства. TemplateSrc свойство задает источник файла шаблона, библиотека шаблонов которого содержит шаблон заголовка. TemplateName свойство задает имя шаблона заголовка. Например, BaseTable библиотека шаблонов генератора отчетов содержит два пронумерованных шаблона заголовка, один именованный BaseTableNumberedTitle для пронумерованных таблиц и одного именованного BaseTableHierNumberedTitle для иерархически пронумерованных таблиц. BaseTable генератор отчетов задает который шаблон использовать путем установки TemplateSrc этого генератора отчетов свойство к BaseTable обработайте по шаблону и TemplateName этого генератора отчетов свойство к заголовку обрабатывает имя по шаблону.

Владелец может также сгенерировать цель гиперссылки перед заголовком путем установки LinkTarget этого генератора отчетов свойство к ID цели ссылки.

Свойства

развернуть все

ID отверстия, чтобы быть заполненным этим генератором отчетов в виде строки.

Содержимое отверстия, чтобы быть заполненным этим генератором отчетов в виде одного из этих значений:

  • Строка или символьный массив

  • Объект DOM

  • 1 N или N-by-1 массив строк или Объектов DOM

  • 1 N или N-by-1 массив ячеек строк, символьных массивов и/или Объектов DOM

Префикс для содержимого заголовка в виде строкового скаляра или вектора символов. Если никакой префикс не задан, префикс заголовка по умолчанию, переведенный на основе локали отчета, используется.

Суффикс для содержимого заголовка в виде строкового скаляра или вектора символов. Если никакой суффикс не задан, суффикс заголовка по умолчанию, переведенный на основе локали отчета, используется.

Переводы заголовка в виде структуры MATLAB®. Структура содержит три поля, которые пусты по умолчанию:

  • Translations.NumberPrefixSuffix

    Если это поле пусто (значение по умолчанию), префиксы номера заголовка и суффиксы не переводятся. Чтобы сгенерировать локализованные версии префикса номера заголовка и суффикса, владелец заголовка устанавливает это поле на containers.MAP MATLAB возразите, что сопоставляет ключ локали со структурой, которая содержит переводы NumberPrefix и Numbersuffix свойства. Структура значения должна содержать эти поля:

    • Locale — ID локали, например, 'en'

    • TitleNumberPrefix — Специфичный для локали префикс номера, например, 'Chapter'

    • TitleNumberSuffix — Специфичный для локали суффикс номера, например, '. '

  • Translations.Content

    Если это поле пусто (значение по умолчанию), содержимое заголовка не переводится. Чтобы сгенерировать локализованные версии содержимого заголовка, владелец генератора отчетов заголовка устанавливает это поле на containers.Map MATLAB возразите, что сопоставляет ключ локали с переводом содержимого заголовка. Если значение этого поля не пусто и значение Content свойство этого генератора отчетов пусто, этот генератор отчетов использует довольное карта, чтобы искать локализованную версию содержимого заголовка.

  • Translations.Owner

    Это свойство используется, чтобы найти перевод содержимого заголовка по умолчанию заданным владельцем заголовка генератор отчетов. Это свойство для внутреннего пользования только.

Если заданная карта перевода не содержит перевод для заданной локали отчета, en локаль используется в качестве локали для заголовка, префикса и суффикса. Смотрите свойство Locale mlreportgen.report.Report для получения информации о допустимых локалях.

Источник шаблона для этого генератора отчетов, заданного одним из этих способов:

  • Вектор символов или строковый скаляр, который задает путь файла, который содержит шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word Microsoft®, TemplateSrc должен быть шаблон генератора отчетов Word. Если TemplateSrc свойство пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.

Имя шаблона для этого генератора отчетов в виде вектора символов или строкового скаляра. Шаблон для этого генератора отчетов должен быть в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов в виде вектора символов или строкового скаляра, который задает ID цели ссылки или mlreportgen.dom.LinkTarget объект. Значение вектора символов или строкового скаляра преобразовано в LinkTarget объект. Цель ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Смотрите также

|

Темы

Введенный в R2018b

Документация MATLAB Report Generator

Поддержка

Для просмотра документации необходимо авторизоваться на сайте