Exponenta Banner

mlreportgen.report.Title class

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

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

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

Описание

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

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

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

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

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

Свойства

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

Идентификатор отверстия, заполняемого этим репортером, задается в виде строки.

Содержимое отверстия, заполняемого этим репортером, задается как одно из следующих значений:

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

  • Объект DOM

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

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

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

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

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

  • Translations.NumberPrefixSuffix

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

    • Locale - идентификатор локали, например 'en'

    • TitleNumberPrefix - Префикс номера для конкретной локали, например 'Chapter'

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

  • Translations.Content

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

  • Translations.Owner

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

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

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

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

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

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

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

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

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

См. также

|

Темы

Введенный в R2018b

MATLAB Report Generator

Поддержка