mlreportgen.report.RptFile class

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

Создайте основанный на Report Explorer генератор отчетов

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

Описание

Используйте RptFile генератор отчетов, чтобы включать содержимое, сгенерированное настройкой Report Explorer (.rpt) файл в отчете API Отчета. Когда добавлено к отчету, RptFile генератор отчетов:

  1. Выполняет заданный файл настройки Report Explorer, чтобы сгенерировать представление XML DocBook отчета Report Explorer

  2. Использует модифицированную версию Report Explorer Docbook-to-DOM шаблон преобразования, чтобы преобразовать XML в набор Объектов DOM (см., Управляют Шаблонами Преобразования Отчета),

  3. Добавляет содержимое DOM к отчету API Отчета.

mlreportgen.report.RptFile классом является handle класс.

Создание

Описание

пример

reporter = RptFile() создает пустой основанный на Report Explorer RptFile генератор отчетов. Прежде, чем добавить генератор отчетов в отчет, ваша программа отчета должна установить SetupFile генератора отчетов свойство к пути настройки Report Explorer (.rpt) файл. В противном случае ошибка происходит.

По умолчанию RptFile генератор отчетов использует шаблон преобразования, который является немного модифицированной версией шаблона преобразования Report Explorer по умолчанию для отчета выходной тип. Например, если отчет, выходным типом является PDF, генератор отчетов, использует немного модифицированную версию шаблона по умолчанию для PDF (from template) Report Explorer 'OutputType' .

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

пример

reporter = RptFile(SetupFile) создает RptFile генератор отчетов на основе заданного файла настройки Report Explorer (.rpt файл). Смотрите свойство SetupFile.

reporter = RptFile(Name,Value) свойства наборов с помощью пар "имя-значение". Можно задать несколько аргументов пары "имя-значение" в любом порядке. Заключите каждое имя свойства в одинарные кавычки.

Свойства

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

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

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

Источник преобразования обрабатывает по шаблону, чтобы использоваться этим генератором отчетов, чтобы преобразовать XML файла настройки выход в Объекты DOM. Пустое значение задает использование шаблона по умолчанию для выходного типа отчета, который будет сгенерирован. Значение строки или символьного массива задает путь настроенной версии шаблона по умолчанию для выходного типа, который будет сгенерирован.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

Имя шаблона для этого генератора отчетов в виде символьного массива или строки. По умолчанию это свойство задает RptFile, имя шаблона генератора отчетов по умолчанию. Этот шаблон по умолчанию находится в библиотеке шаблонов его шаблона преобразования по умолчанию наряду с другими шаблонами, используемыми, чтобы преобразовать компоненты XML Report Explorer в Объекты DOM. Шаблон генератора отчетов по умолчанию содержит одно отверстие под названием Content быть заполненным содержимым DOM, преобразованным от содержания XML, сгенерированного настройкой. Если вы меняете имя этого шаблона, необходимо установить это свойство на новое имя. Можно изменить сам шаблон, но модифицированный шаблон должен содержать отверстие под названием Содержимое.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

Цель гиперссылки для этого генератора отчетов в виде символьного массива или строки, которая задает ID цели ссылки или mlreportgen.dom.LinkTarget объект. Значение строки или символьного массива преобразовано в LinkTarget объект. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string | object

Методы

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

Примеры

Создайте генератор отчетов RptFile

Создайте RptFile генератор отчетов, не задавая файл настройки. Затем используйте SetupFile свойство задать файл настройки Report Explorer.

reporter = mlreportgen.report.RptFile();
reporter.SetupFile = "my_setup_file.rpt"

Добавьте подсвеченный синтаксисом код в отчет

Используйте RptFile генератор отчетов, чтобы добавить подсветку синтаксиса в код в Отчете API Отчета.

Примечание

Прежде чем вы запустите этот пример, используйте Report Explorer, чтобы создать файл настройки под названием highlight_syntax.rpt. Файл настройки для этого примера содержит Предварительно отформатированный компонент с этим текстом в его окне редактирования: 

% To import the Report API Package, use this command:
%<code_var>
Включите Show text as syntax-highlighted MATLAB code, который является ниже текстового поля Preformatted. Смотрите Создают Файл настройки Отчета.

Этот код создает отчет API Отчета, который включает highlight_syntax.rpt файл настройки.

rpt = mlreportgen.report.Report("My Report","pdf");

chap = mlreportgen.report.Chapter...
  ("Include Report Explorer Report Using the RptFile Reporter");
sect1 = mlreportgen.report.Section...
  ("Highlighted Syntax Example");

% Evaluate the expression and assign it to the code variable
evalin('base','code_var = "import mlreportgen.report.*"');

rptfile = mlreportgen.report.RptFile("highlight_syntax.rpt");

add(sect1,rptfile)
add(chap,sect1)
add(rpt,chap)

close(rpt)
rptview(rpt)

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

|

Темы

Введенный в R2019a

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

Поддержка

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