mlreportgen.dom.LOT class

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

Описание

Используйте объект mlreportgen.dom.LOT класс, чтобы создать список таблиц в отчете.

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

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

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

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

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

Включать таблицы в список таблиц:

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

  2. Сопоставьте Paragraph объекты с потоком нумерации, который имеет имя table при помощи mlreportgen.dom.AutoNumber объект.

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Создайте список таблиц как mlreportgen.dom.LOT объект. Включать таблицы в список:

  • Создайте заголовки для таблиц как mlreportgen.dom.Paragraph объекты.

  • Сопоставьте Paragraph объекты с потоком нумерации, который имеет имя table.

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

import mlreportgen.dom.*

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

d = Document("DOM Report with List of Tables","docx");

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

lotObj = LOT();
append(d,lotObj);
append(d,PageBreak);

Составление таблицы.

t1 = Table(magic(2));

Создайте абзац для табличного заголовка.

p1 = Paragraph("Table ");

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

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

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

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

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

append(p1,".");
append(p1," Order 2 Magic Square");
append(d,p1);

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

append(d,t1);

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

t2 = Table(magic(3));
p2 = Paragraph("Table ");
append(p2,AutoNumber("table"));
p2.Style = {CounterInc("table"),WhiteSpace("preserve")};

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

append(p2,".");
append(p2, " Order 3 Magic Square");
append(d,p2);

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

append(d,t2);

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

close(d);
rptview(d);

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

Введенный в R2020b