Exponenta Banner
exponenta event banner

mlreportgen.report.SeyTitle класс

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

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

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

Описание

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

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

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

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

Свойства

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

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

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

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

  • Объект DOM

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

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

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

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

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

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

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

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

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

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

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

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

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

См. также

| | |

Темы

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

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

Поддержка