Exponenta Banner

mlreportgen.report.RptFile class

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

Создайте репортер на основе Report Explorer

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

Описание

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

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

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

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

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

Создание

Описание

пример

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

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

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

пример

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

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

Свойства

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Методы

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

Примеры

Создайте репортер RptFile

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

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

Добавление синтаксиса - подсвеченного кода к отчету

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

Примечание

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

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

Этот код создает отчет Report 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

Поддержка