Exponenta Banner
exponenta event banner

mlreportgen.dom.TOC класс

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

Создать местозаполнитель для создания оглавления

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

Описание

Создайте местозаполнитель для оглавления документа. При открытии созданного документа Word Слово заменяет местозаполнитель создаваемым оглавлением. Аналогично, когда созданный HTML-документ открывается в HTML-браузере, браузер заменяет заполнитель создаваемым оглавлением. Для PDF DOM API заменяет местозаполнитель оглавлением, которое создается при выводе документа.

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

Строительство

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

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

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

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

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

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

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

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

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

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

Свойства

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

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

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

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

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

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

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

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

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

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

DOM создает уникальный для сеанса тег как часть создания этого объекта. Созданный тег имеет вид CLASS: ID, где CLASS - класс объекта, а 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

Поддержка