mlreportgen.dom. Контейнерный класс

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

Контейнер объектов документа

Описание

Создает контейнерный элемент. Используйте метод mlreportgen.dom.Container.append, чтобы добавить элементы документа к контейнеру. Используйте объект mlreportgen.dom.Container в отчете применить форматы ко всем дочерним элементам контейнера.

В выводе HTML объект Container генерирует элемент HTML типа, заданного его свойством HTMLTag и содержащий элементы HTML, соответствующие его содержимому DOM. Например, объект Container со свойством HTMLTag div и это содержат текст, Hello World генерирует эту разметку:

<div><p><span>Hello World</span></p></div>

Сгенерированный элемент контейнера HTML имеет класс и свойства стиля, заданные свойствами StyleName и Style объекта Container, соответственно. Правила наследования формата CSS HTML гарантируют, что сгенерированные дочерние элементы объекта Container наследовали форматы, заданные свойствами Style и StyleName объекта Container. Например, если объект Container задает красный как его цвет текста, и ни один из его текстовых дочерних элементов не задает цвет, текстовые дочерние элементы окрашены в красный.

Для Microsoft® Word и отчет PDF вывод, объект Container моделирует наследование формата контейнера, применяя форматы, заданные объектом Container атрибут Style каждому дочернему элементу, если не заменено дочерним элементом, и затем добавляя дочерний элемент к выводу. Word и PDF вывод игнорирует свойства HTMLTag и StyleName объекта Container.

Совет

Можно использовать mlreportgen.dom.Container, или mlreportgen.dom.Group возражает, чтобы произвести наборы элементов документа.

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

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

Конструкция

containerObj = Container() создает контейнер с именем HTML-тэга div.

пример

containerObj = Container(HTMLtag) создает контейнер с заданным именем HTML-тэга (например, div, section или article).

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

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

Имя тега контейнера HTML, заданное как вектор символов. Имя должно быть элементом HTML, таким как 'div', 'section' или 'article'.

Примечание

Word вывод игнорирует тег контейнера HTML.

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

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

Контейнер объектов документа, возвращенных как объект mlreportgen.dom.Container.

Свойства

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

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

Эти дочерние элементы списков свойств только для чтения, которые содержит контейнер.

Имя тега контейнера HTML, заданное как вектор символов. Имя должно быть элементом HTML, таким как 'div', 'section' или 'article'.

Примечание

Word вывод игнорирует тег контейнера HTML.

Это списки свойств только для чтения родительский элемент этого элемента документа.

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

Разработайте имя, заданное как вектор символов. Имя стиля является именем стиля, заданного в таблице стилей части документа или документа, к которой добавлен этот элемент. Заданный стиль задает внешний вид этого элемента в выходном документе где не замененный форматами, заданными свойством Style этого элемента.

Примечание

Word вывод игнорирует имя стиля.

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

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

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

Методы

добавлениеДобавьте Объект DOM к контейнеру
клонСкопируйте контейнерный объект

Примеры

свернуть все

Создайте контейнерный объект. Word вывод игнорирует тег элементов контейнера HTML (в этом примере, теге div).

import mlreportgen.dom.*;
rpt = Document('MyReport','docx');

c = Container();

Окрасьте весь текст контейнера красным.

c.Style = {Color('red')};

Добавьте содержимое к контейнеру и добавьте контейнер к отчету.

append(c,Paragraph('Hello'));
append(c,Table(magic(5)));
append(rpt,c);

Закройте и сгенерируйте отчет.

close(rpt);
rptview(rpt.OutputPath);

Представленный в R2015a