mlreportgen.dom.TOC class

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

Создайте заполнителя для генерации оглавления

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

Описание

Создайте заполнителя для оглавления документа. Когда сгенерированный документ Word открывается, Word заменяет заполнителя на TOC, который это генерирует. Точно так же, когда сгенерированный документ HTML открывает в браузере HTML, браузер заменяет заполнителя на TOC, который это генерирует. Для PDF API DOM заменяет заполнителя на TOC, который это генерирует при выводе документа.

Во всех случаях Элементы оглавления состоят из содержимого абзацев с помощью количества направляющихся уровней, которые вы задаете. Для PDF и Word, заполнитель TOC также задает лидера, который заполняет пробел между содержимым и номером страницы в Элементе оглавления.

Конструкция

toc = TOC() генерирует трехуровневый TOC, который использует точечного лидера.

toc = TOC(levels) использует конкретное количество направляющихся уровней.

toc = TOC(levels,leader) использует заданного лидера.

Входные параметры

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

Количество направляющихся уровней, чтобы использовать в TOC в виде положительного целого числа.

Тип лидера, чтобы использовать между заголовком и номером страницы в виде '.' (т.е. период или точка) или ' ' (пробел).

Выходные аргументы

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

Оглавление, возвращенное как mlreportgen.dom.TOC объект.

Свойства

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

Дочерние элементы этого элемента документа в виде массива Объектов DOM. Это свойство доступно только для чтения.

Пользовательские атрибуты этого элемента в виде массива mlreportgen.dom.CustomAttribute объекты. Используйте пользовательские атрибуты, поддержанные выходным форматом.

ID для этого элемента документа в виде вектора символов или строкового скаляра. DOM генерирует уникальный идентификатор сеанса, когда он создает элемент документа. Можно задать собственный ID.

Тип лидера, чтобы использовать между заголовком и номером страницы в виде '.' (т.е. период или точка) или.' ' (пробел).

Количество направляющихся уровней, чтобы использовать в TOC в виде положительного целого числа.

Родительский элемент этого элемента документа в виде Объекта DOM. Это свойство доступно только для чтения.

Объекты формата, которые задают формат элемента документа.

Имя стиля, чтобы применяться из таблицы стилей в виде вектора символов.

Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и ID является значением Id свойство объекта. Определение вашего собственного значения тега может помочь вам идентифицировать, где проблема произошла во время генерации документов.

Примеры

свернуть все

Открыть скрипт

Этот пример добавляет оглавление в документ с помощью TOC объект. Этот документ содержит три уровня голов — |Heading1 |, Heading2, и Heading3. Поскольку TOC объект задает только два направляющихся уровня, Heading3 не включен в TOC. Лидер является пробелом.

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

title = append(d, Paragraph('My TOC Document'));
title.Bold = true;
title.FontSize = '28pt';

toc = append(d,TOC(2,' '));
toc.Style = {PageBreakBefore(true)};

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
h2.Style = {PageBreakBefore(true)};
p2 = append(d,Paragraph('Another page'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d, Paragraph('My Level 3 Heading Text'));

close(d);
rptview(d.OutputPath);

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

| |

Темы

Введенный в R2016a

Документация MATLAB Report Generator

Поддержка

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