Exponenta Banner

mlreportgen.dom. Класс DocumentPart

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

Создайте объект части документа

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

Описание

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

Конструкция

documentPartObj = DocumentPart() создает часть документа HTML с помощью шаблона HTML по умолчанию.

documentPart = DocumentPart(type) создает часть документа заданного типа (например, Microsoft® Word) на основе шаблона по умолчанию для той части.

documentPartObj = DocumentPart(type,templatePath) создает часть документа на основе заданного шаблона.

documentPartObj = DocumentPart(type,templatePath,docPartTemplateName) создает часть документа на основе заданного шаблона части документа в заданном шаблоне.

documentPartObj = DocumentPart(templateSrc,docPartTemplateName) создает часть документа на основе заданного шаблона части документа, сохраненного в шаблоне, используемом заданным источником. Источник может быть документом или частью документа.

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

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

Тип вывода, заданного как одно из этих значений:

  • 'html' — Вывод HTML

  • 'pdf' — PDF на основе шаблона PDF

  • 'docx' — Word вывод

  • 'html-file' — Вывод HTML, с помощью одного файла, который содержит CSS, JavaScript®, и отображает для отчета

Если вы задаете шаблон с помощью аргумента templatePath, значение для type должно совпадать с типом шаблона.

Полный путь файла шаблона этой части или папки, заданной как вектор символов. Если вы не используете расширение файла, тип шаблона основан на типе документа, например, .docx для Word.

Типы данных: char

Часть документа обрабатывает по шаблону имя, заданное как вектор символов. Задайте, где часть хранится с помощью аргумента templatePath или templateSrc.

Документ или часть документа возражают, чей шаблон содержит шаблон для этой части документа, заданной как объект mlreportgen.dom.Document для документа или объект mlreportgen.dom.DocumentPart для части документа.

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

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

Часть документа, возвращенная как объект mlreportgen.dom.DocumentPart.

Свойства

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

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

Это свойство только для чтения является ID дыры текущей дыры в этом документе.

Тип текущей дыры шаблона, заданной как 'Inline' или 'Block'.

  • Встроенная дыра для элементов документа, которые может содержать элемент абзаца: Text, Image, LinkTarget, ExternalLink, InternalLink, CharEntity, AutoNumber.

  • Дыра блока может содержать Paragraph, Table, OrderedList, UnorderedList, DocumentPart или Group.

Это свойство применяется к Word и документам в формате PDF. Для документов Word значение является объектом DOCXPageLayout, который задает текущий макет страницы. Для документов в формате PDF значение является объектом PDFPageLayout, если документ в настоящее время задает макет страницы. Для документов HTML значение всегда [].

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

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

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

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

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

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

Имя шаблона этой части, если шаблон хранится в библиотеке шаблонов части документа шаблона, заданного свойством TemplatePath этой части. Если это свойство [], шаблон, заданный свойством TemplatePath, используется в качестве шаблона этой части.

Путь шаблона этой части или шаблона, библиотека шаблонов которого содержит шаблон этой части, заданный как вектор символов.

Выведите тип, заданный как одно из этих значений.

  • 'HTML' – Отчет HTML, группированный как заархивированный файл, содержащий файл HTML, изображения, таблицу стилей и файлы JavaScript отчета.

  • 'HTML-FILE' – Отчет HTML как один файл HTML, содержащий текст, таблицу стилей, JavaScript и base64-закодированные изображения отчета

  • 'PDF' – PdfFile

  • 'DOCX' – Документ Microsoft Word

Если вы задаете шаблон с помощью свойства TemplatePath, значение для Type должно совпадать с типом шаблона.

Методы

Используйте методы DocumentPart как вы, используют соответствующие методы Document.

Метод

Цель

addHTML

Используйте DocumentPart.addHTML похожим способом к тому, как вы используете Document.addHTML.

Добавьте текст HTML к документу

addHTMLFile

Используйте DocumentPart.addHTMLFile похожим способом к тому, как вы используете Document.addHTMLFile.

Добавьте содержимое файла HTML к документу

append

Добавьте элемент документа к части документа.

close

Закройте эту часть документа. Вы не можете закрыть часть документа, если она не была открыта или была ранее закрыта.

createTemplate

Создайте шаблон части документа.

fill

Заполните дыру документа.

getCoreProperties

Получите базовые свойства части документа.

getOPCMainPart

Получите полный путь основной части выходного документа.

moveToNextHole

Переместитесь, чтобы затем обработать дыру по шаблону.

open

Откройте эту часть документа. Вы не можете открыть часть документа, если она была ранее открыта или закрыта. Вы также не можете открыть часть документа, если ее источник библиотеки закрывается.

setCoreProperties

Установите базовые свойства части документа.

Примеры

свернуть все

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

Создайте функцию.

function magic_square_report(square_sizes, report_type)
%MAGIC_SQUARE_REPORT Report on magic squares
%    magic_square_report(square_sizes, report_type) 
%    creates a report of the specified output type 
%    (docx, pdf, or html) on the specified magic
%    squares. For example, to create a PDF report on 
%    squares of size 5, 10, and 15, enter the following 
%    line at the MATLAB command line:
%
%      magic_square_report([5,10,15],'pdf');

import mlreportgen.dom.*;
rpt = Document('MagicSquareReport',report_type);
open(rpt);
for i = 1:length(square_sizes)
    sz = square_sizes(i);
    section = createSquareSection(rpt,sz);
    append(rpt,section);
end
close(rpt);
rptview(rpt.OutputPath);
 
function section = createSquareSection(rpt,square_size)
import mlreportgen.dom.*;
% Create document part to hold section
section = DocumentPart(rpt.Type);
% Create magic square heading
h1 = Heading1(sprintf('magic(%i)',square_size));
% Put each square on a separate page.
h1.Style = {PageBreakBefore(true)};
append(section,h1);
% Create table to hold square
table = append(section, Table(magic(square_size)));
% Format table
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';

Вызовите функцию, чтобы сгенерировать отчет. Измените входные параметры, чтобы изменить содержимое или выходной формат. Этот пример создает документ Word, который содержит три квадрата.

 magic_square_report([5,8,12],'docx');

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

Темы

Документация MATLAB Report Generator
Поддержка