mlreportgen.dom.Template class

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

Создайте объект шаблона отчета

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

Описание

Создайте объект шаблона отчета.

Используйте mlreportgen.dom.Template объекты создать шаблоны. Например, можно добавить содержимое DOM (например, Text, Paragraphизображение) объекты и TemplateHole объекты) к Template объект создать шаблон, содержащий зафиксированное содержимое с отверстиями для сгенерированного содержимого.

Примечание

Word для Mac не поддерживает отверстия создания для шаблонов API DOM. Если необходимо создать шаблон Word для генерации документов Word о Mac, можно создать шаблон с помощью API DOM. Создайте Template объект и использование mlreportgen.dom.TemplateHole добавить отверстия. В качестве альтернативы используйте Word на Windows®, чтобы создать ваш шаблон и скопировать шаблон в ваш Mac.

Конструкция

templateObj = Template() создает объект шаблона на основе шаблона HTML по умолчанию. Получившийся шаблон находится в текущей папке и использует имя Untitled.htmtx.

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

templateObj = Template(templatePath) создает объект шаблона, который выводит файл шаблона в заданном местоположении. Шаблон по умолчанию вводит, если вы не указываете, что расширение является HTML.

templateObj = Template(templatePath,type) создает шаблон заданного типа. Если вы задаете расширение с помощью templatePath, типы должны соответствовать.

Совет

Используйте переменную для type аргумент, чтобы упростить ваш код. Смотрите Создают Шаблон и Добавляют Содержимое для примера.

templateObj = Template(templatePath,type,sourceTemplatePath) создает шаблон на основе шаблона sourceTemplatePath.

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

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

Полный путь шаблона вы хотите создать в виде вектора символов. Можно использовать расширение, чтобы создать шаблон соответствующего типа:

  • .htmtx для HTML (значение по умолчанию)

  • .docx для Word

  • .htmt для однофайлового HTML

  • .pdf для PDF

Тип шаблона в виде одного из этих значений:

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

  • 'docx'— Шаблон Word

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

  • .pdf — Шаблон PDF

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

Обработайте по шаблону, который является основанием для нового шаблона в виде вектора символов. Исходный тип шаблона должен совпадать с type аргумент.

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

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

Обработайте по шаблону, чтобы создать, возвращенный как mlreportgen.dom.Template объект.

Свойства

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

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

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

Тип текущего отверстия шаблона в виде 'Inline' или 'Block'.

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

  • Отверстие блока может содержать ParagraphТаблица, OrderedList, UnorderedList, DocumentPart, или Group.

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

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

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

Пользовательское содержимое для заголовка HTML в виде вектора символов.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 'docx' — Word выход

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

  • 'pdf' — PDF выход

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

Методы

Используйте Template методы тем же путем вы используете соответствующий Document методы.

Метод

Цель

append

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

close

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

mlreportgen.dom.Document.createTemplate

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

fill

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

mlreportgen.dom.Document.getCoreProperties

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

mlreportgen.dom.Document.getImageDirectory

Получите каталог образов для документа.

mlreportgen.dom.Document.getImagePrefix

Получите сгенерированный префикс названия картинки для документа.

getMainPartPath

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

mlreportgen.dom.Document.getOPCMainPart

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

moveToNextHole

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

open

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

package

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

mlreportgen.dom.Document.setCoreProperties

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

Примеры

свернуть все

Этот пример создает шаблон с отверстием для заголовка и отверстием для автора. Можно изменить значение type переменная, чтобы создать шаблон одного из других типов.

import mlreportgen.dom.*;

type = 'docx';

% Create a template object
t = Template('mytemplate',type);

% Add a title hole to the template and apply the Title style
hole = append(t,TemplateHole('TITLE'));
hole.Description = ('Title Description');
hole.DefaultHoleStyleName = 'Title';

% Add a paragraph with boilerplate text and apply the Subtitle format
% Position the paragraph and preserve white space in the text 
p = Paragraph('Author: ');
p.StyleName = 'Subtitle';
p.Style = {OuterMargin('0','0','1in','1in')};
p.WhiteSpace = 'preserve';

% Append an inline hole to paragraph  
hole = append(p,TemplateHole('AUTHOR'));
append(t,p);

close(t);

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

% Create a document TitleAuthor that uses the template mytemplate.
rpt = Document('TitleAuthor',type,'mytemplate');
open(rpt);

% Create a loop to cycle through the holes. 
% Append content to each hole.
while(~strcmp(rpt.CurrentHoleId,'#end#'))
    switch(rpt.CurrentHoleId)
        case 'TITLE'
            append(rpt,Paragraph('This Is My Title'));
        case 'AUTHOR'
            append(rpt,'My Name');
    end
    
    moveToNextHole(rpt);
end

% Generate and view the report.
close(rpt);
rptview(rpt.OutputPath)

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

| |

Темы

Документация MATLAB Report Generator

Поддержка

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