mlreportgen.dom.Container class

Пакет: 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 имеет класс и свойства стиля, заданные Container объект StyleName и Style свойства, соответственно. Правила наследования формата CSS HTML гарантируют что сгенерированные дочерние элементы Container объект наследовал форматы, заданные Container объект Style и StyleName свойства. Например, если 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.

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

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

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

Примечание

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

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

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