mlreportgen.dom.TOC class

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

Создайте заполнитель для генерации таблицы содержимого

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

Описание

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

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

Конструкция

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

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

toc = TOC(levels,leader) использует заданную выноску.

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

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

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

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

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

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

Таблица содержимого, возвращенная как mlreportgen.dom.TOC объект.

Свойства

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

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

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

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

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

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

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

Форматирование объектов, задающих формат элемента документа.

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

Тег для этого элемента документа, заданный как вектор символов или строковый скаляр.

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

Примеры

свернуть все

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

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

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

Поддержка

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