Exponenta Banner

mlreportgen.dom. Класс документов

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

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

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

Описание

Создайте объект mlreportgen.dom.Document, который задает:

  • Тип вывода: HTML, Microsoft® Word или PDF.

  • Где и как сохранить вывод.

  • Шаблон, чтобы использовать, чтобы отформатировать документ.

Конструкция

documentObj = Document() создает документ HTML под названием Untitled.htmx в текущем каталоге, с помощью шаблона HTML по умолчанию.

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

documentObj = Document(outputPath) создает документ HTML в заданном местоположении.

documentObj = Document(outputPath,type) создает документ заданного типа (например, Word), с помощью шаблона по умолчанию для того типа.

documentObj = Document(outputPath,type,templatePath) создает документ, с помощью заданного типа документа и Word, PDF или шаблона HTML, соответствующего установке type.

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

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

Полный путь выходного файла или папки для этого документа. Если вы не задаете расширение файла, расширение основано на типе документа (например, .docx для Microsoft Word). Можно установить это свойство только прежде, чем открыть документ.

Как вы указываете, что путь зависит от значения свойства PackageType.

  • 'zipped' — Имя zip-файла.

  • 'unzipped' — Папка для выходных файлов.

  • 'both' — Имя zip-файла.

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

Тип вывода, заданного как 'html', 'docx', 'pdf' или 'html-file'.

  • 'html' — Вывод HTML как заархивированная или разархивированная папка, содержащая текст документа HTML, изображение, таблицу стилей и файлы JavaScript®.

  • 'docx' — Word вывод.

  • 'pdf' — Документ в формате PDF на основе шаблона PDF.

  • 'html-file' — Вывод HTML, состоящий из одного файла, который содержит текст, таблицы стилей, JavaScript, и отображает для отчета

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

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

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

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

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

Сообщите о документе определения, представленном объектом mlreportgen.dom.Document.

Свойства

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

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

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

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

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

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

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

Установите это свойство на true перезаписывать существующий выходной файл того же имени для отчета из этого документа. Если этим свойством является false, и перезаписываемый файл того же имени существует, пытаясь закрыться (т.е. запись), этот документ вызывает ошибку. Если существующий файл только для чтения, закрытие этого документа вызывает ошибку независимо от установки этого свойства.

Типы данных: логический

Пользовательское содержимое для заголовка HTML, заданного как вектор символов. Значение этого свойства добавлено к элементу <head> этого документа после содержимого, заданного главным разделом шаблона документа. Установите это свойство только прежде, чем открыть документ.

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

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

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

Для разархивированной выходной упаковки путь задает папку для выходных файлов. Значением по умолчанию является текущая папка.

Упаковка для выходных файлов, заданных как одно из этих значений:

  • 'zipped' — Применяется только к Word и многофайловому выводу HTML

  • 'unzipped' — Применяется только к Word и многофайловому выводу HTML

  • 'both' — Применяется только к Word и многофайловому выводу HTML

  • 'single-file' — Создает отчет как один файл. Это значение появляется, если вы устанавливаете свойство Type документа на 'pdf' или 'html-file'. Вы не можете установить или изменить это значение сами.

Для заархивированной упаковки документ вывел, zip-файл, расположенный в местоположении, заданном свойством OutputPath. Zip-файл имеет расширение, которое совпадает с типом документа: docx для Word вывод или htmtx для вывода HTML. Например, если типом документа является docx, и OutputPath является s:\docs\MyDoc, вывод группирован в zip-файле под названием s:\docs\MyDoc.docx.

Для разархивированной упаковки документ вывел, хранится в папке, имеющей корневое имя файла свойства OutputPath. Например, если OutputPath является s:\docs\MyDoc, выходной папкой является s:\docs\MyDoc.

Если вы устанавливаете PackageType на both, генерирование отчета производит заархивированный и разархивированный вывод.

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

По умолчанию элементы документа хранятся в памяти, пока документ не закрывается. Установите это свойство на true писать элементы документа в диск, когда элементы добавлены к документу.

Типы данных: логический

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

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

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

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

Для документов HTML это свойство задает текст, который появляется в строке заголовка браузера, используемого, чтобы отобразить этот документ. Word и документы в формате PDF игнорируют это свойство.

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

Тип вывода, заданного как 'html', 'docx', 'pdf' или 'html-file'.

  • 'html' — Вывод HTML как заархивированная или разархивированная папка, содержащая текст документа HTML, изображение, таблицу стилей и файлы JavaScript.

  • 'docx' — Word вывод.

  • 'pdf' — PDF вывод.

  • 'html-file' — Вывод HTML, состоящий из одного файла, который содержит текст, таблицы стилей, JavaScript, и отображает для отчета.

Если вы задаете шаблон с помощью свойства TemplatePath, шаблон должен быть сопоставим с аргументом Type. Необходимо задать шаблон Word (.dotx) для docx вывод, пакет шаблона HTML (.htmtx) для вывода HTML, пакет шаблона PDF (.pdftx) для PDF вывод и однофайловый шаблон HTML (.htmt) для html-file вывод.

Методы

Метод

Цель

addHTML

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

addHTMLFile

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

append

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

close

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

createAutoNumberStream

Автоматически создайте сгенерированный поток нумерации.

createTemplate

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

fill

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

getAutoNumberStream

Получите автоматизированный поток нумерации.

getCoreProperties

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

getMainPartPath

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

getOPCMainPart

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

moveToNextHole

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

open

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

package

Добавьте файл к пакету OPC документа.

setCoreProperties

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

Примеры

свернуть все

Открыть скрипт

Создайте документ Word, добавьте содержимое и просмотрите отчет в Word.

import mlreportgen.dom.*;
d = Document('mydoc','docx');

append(d,'Hello World');

close(d);
rptview(d.OutputPath);

Создайте документ HTML как один файл HTML, который включает изображения документа. Пример принимает, что существует изображение MyImage.jpg и файл шаблона HTML myHTMLTemplate.htmt.

Создайте документ, вывод которого является одним файлом HTML и использует шаблон myHTMLTemplate. Добавьте текст и изображение к отчету. Закройте документ и просмотрите его.

import mlreportgen.dom.*;
d = Document('mydoc','html-file','myHTMLTemplate'); 
open(d); 

append(d,'Hello world'); 
append(d,Image('C:/images/LocalSystem/MyImage.jpg'));

close(d); 
rptview(d.OutputPath);

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

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