mlreportgen.report.SectionTitle class

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

Сгенерируйте заголовок раздела

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

Описание

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

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

Владелец определяет местоположение шаблона заголовка с образцом TemplateSrc, TemplateName, и OutlineLevel свойства. The TemplateSrc свойство задает источник файла шаблона, библиотека шаблонов которого содержит шаблон заголовка. The TemplateName свойство задает корневое имя шаблона заголовка. The OutlineLevel свойство задает уровень в иерархии отчетов содержимого, сгенерированного владельцем. The SectionTitle образец добавляет значение OutlineLevel свойство значению TemplateName свойство для создания полного имени шаблона заголовка. Для примера, Section библиотека шаблонов reporter содержит шесть пронумерованных шаблонов заголовков, каждый из которых соответствует уровню разделов. Имена шаблонов SectionNumberedTemplate1, SectionNumberedTemplate2и так далее. Чтобы задать использование SectionNumberedTemplate1 шаблон, чтобы сгенерировать заголовок раздела, Section reporter устанавливает SectionTitle TemplateName свойство к SectionNumberedTemplate и OutlineLevel свойство для 1.

Если на SectionTitle LinkTarget задано свойство, образец предшествует сгенерированному заголовку с целью ссылки, имеющей указанный целевой идентификатор.

Свойства

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

Имя отверстия заголовка в шаблоне владельца в виде вектора символов или строкового скаляра.

Текст заголовка, заданный как одно из следующих значений:

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

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

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

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

Уровень контура репортера-владельца в иерархии раздела отчета, заданный как положительное целое число в области значений [1,6]. The OutlineLevel свойство задает уровень раздела, сгенерированного репортером-владельцем в иерархии разделов отчета. The SectionTitle reporter добавляет значение этого свойства к значению TemplateName свойство для создания полного имени шаблона заголовка. Для примера, если значение TemplateName свойство SectionNumberedTitle и значение OutlineLevel свойство имеет значение 2, этот репортер генерирует SectionNumberedTitle2 как полное имя шаблона заголовка. Библиотека шаблонов, заданная в TemplateSrc свойство должно содержать шаблон с сгенерированным именем. В противном случае возникает ошибка.

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

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

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

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

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

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

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

См. также

| | |

Темы

Введенный в R2018b

MATLAB Report Generator

Поддержка

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