mlreportgen.report.SectionTitle class

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

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

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

Описание

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

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

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

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

Свойства

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

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

Текст заголовка в виде одного из этих значений:

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

  • Объект DOM

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

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

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

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

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

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

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

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

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

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

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

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

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

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

| | |

Темы

Введенный в R2018b

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