mlreportgen.dom.LOC class

Пакет: mlreportgen.dom

Список заголовков

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

Описание

Используйте объект mlreportgen.dom.LOC класс, чтобы сгенерировать список озаглавленных элементов отчета. Чтобы сгенерировать список фигур с заголовками или таблицами с заголовками, используйте объекты mlreportgen.dom.LOF и mlreportgen.dom.LOT классы, соответственно. Чтобы сгенерировать список для других типов элементов отчета, таких как уравнения, используют LOC объект.

Каждый элемент списка содержит заголовок элемента отчета и ссылок на заголовок в отчете. В PDF или Microsoft® Отчет Word, элемент списка также включает номер страницы и лидера, который заполняет пробел между заголовком и номером страницы.

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

Включать элементы отчета в список:

  1. Выберите потоковое имя нумерации, например, equation. Установите AutoNumberStreamName свойство LOC возразите против потокового имени нумерации.

  2. Создайте заголовки или заголовки для элементов отчета с помощью mlreportgen.dom.Paragraph объекты.

  3. Сопоставьте Paragraph объекты с потоком нумерации называют при помощи mlreportgen.dom.AutoNumber объект.

Путем список сгенерирован, зависит от типа отчета.

  • PDF — API DOM генерирует список во время генерации отчета.

  • Word API DOM генерирует заполнителя для списка. Чтобы сгенерировать элементы списка, необходимо обновить документ Word в программе генерации отчета или в Word. Смотрите Обновление Оглавление или Сгенерированный Список, одним словом, Документ.

  • HTML — API DOM генерирует заполнителя для списка. Когда отчет открывает в браузере HTML, браузер генерирует список.

Примечание

Можно использовать LOC объект для заголовков, которые следуют за элементом отчета или заголовками, которые предшествуют элементу отчета.

mlreportgen.dom.LOC классом является handle класс.

Атрибуты класса

ConstructOnLoad
true
HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

пример

LOCObj = mlreportgen.dom.LOC() создает mlreportgen.dom.LOC объект и наборы свойство LeaderPattern к '.'.

LOCObj = mlreportgen.dom.LOC(leaderPattern) создает mlreportgen.dom.LOC объект и наборы свойство LeaderPattern к заданному шаблону лидера.

Свойства

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

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

Тип лидера, чтобы использовать между заголовком и номером страницы в виде одного из этих векторов символов или строковых скаляров:

  • '.' или 'dots'

  • ' ' или 'space'

Это свойство применяется только к отчетам PDF. Отчеты Word всегда имеют лидера точек. Отчеты HTML не имеют лидера.

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

Стиль задан StyleName свойство должно быть задано в таблице стилей части документа или документа, к которой добавлен этот список заголовков. Заданный стиль задает внешний вид списка заголовков в выходном документе, за исключением форматов, которые заданы Style свойство этого LOC объект. Объекты формата заданы Style форматы переопределения свойства заданы таблицей стилей.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

Этот пример генерирует список заголовков, например, код в отчете. Можно использовать ту же процедуру, чтобы сгенерировать список заголовков для других элементов отчета. Этот пример идентифицирует заголовки, чтобы включать в список путем соединения заголовков с автоматическим потоком нумерации, который имеет имя example. Можно использовать любое имя для потока нумерации, пока имя совпадает со значением AutoNumberStream свойство mlreportgen.dom.LOC объект, который представляет список заголовков.

Импортируйте пакет API DOM так, чтобы вы не использовали долго, полностью определенные имена классов.

import mlreportgen.dom.*

Создайте отчет.

d = Document("DOM Report with List of Captions","pdf");

Создайте список заполнителя заголовков и добавьте его к отчету.

locObj = LOC();
locObj.AutoNumberStreamName = "example";
append(d,locObj);
append(d,PageBreak);

Создайте абзац, который включает пример кода.

pr1 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");
append(d,pr1);

Создайте абзац для заголовка примера кода.

p1 = Paragraph("Example ");

Создайте автоматический поток нумерации с именем example и сопоставьте его с абзацем.

append(p1,AutoNumber("example"));

Постепенно увеличьте счетчик для потока нумерации.

p1.Style = {CounterInc("example"),WhiteSpace("preserve")};

Добавьте остальную часть текста подписи к абзацу и добавьте абзац к отчету.

append(p1,".");
append(p1," Addition");
append(d,p1);

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

pr2 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a * b;");
append(d,pr2);
p2 = Paragraph("Example ");
append(p2,AutoNumber("example"));
p2.Style = {CounterInc("example"),WhiteSpace("preserve")};

Добавьте остальную часть текста подписи к абзацу и добавьте абзац к отчету.

append(p2,".");
append(p2," Multiplication");
append(d,p2);

Закройте и просмотрите отчет.

close(d);
rptview(d);

Вот список заголовков в сгенерированном отчете:

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

| | | | | |

Темы

Введенный в R2020b

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

Поддержка

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