Exponenta Banner
exponenta event banner

mlreportgen.report.Title класс

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

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

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

Описание

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

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

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

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

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

Свойства

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

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

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

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

  • Объект DOM

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

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

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

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

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

  • Translations.NumberPrefixSuffix

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

    • Locale - идентификатор языкового стандарта, например, 'en'

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

    • TitleNumberSuffix - суффикс номера для конкретного языка, например, '. '

  • Translations.Content

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

  • Translations.Owner

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

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

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

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

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

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

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

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

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

См. также

|

Темы

Представлен в R2018b

Документация по генератору отчетов MATLAB

Поддержка