mlreportgen.dom.Container class

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

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

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

Описание

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

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

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

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

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

Совет

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

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

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

Конструкция

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

пример

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

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

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

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

Примечание

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

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

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

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

Свойства

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

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

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

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

Примечание

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

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

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

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

Примечание

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

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

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

MATLAB Report Generator

Поддержка

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