Exponenta Banner

mlreportgen.report. Класс RptFile

Пакет: 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, генератор отчетов, использует немного измененную версию шаблона по умолчанию для Report Explorer's PDF (from template) тип вывода.

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

пример

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

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

Свойства

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

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

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

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

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

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

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

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Типы данных: 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
Поддержка