Exponenta Banner

slreportgen.report.DocBlock class

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

DocBlock генератор отчетов

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

Описание

Используйте объект slreportgen.report.DocBlock класс, чтобы сообщить относительно блока DocBlock.

Примечание

Чтобы использовать генератор отчетов DocBlock в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс или подкласс.

Генератор отчетов включает содержимое DocBlock в отчет одним из этих способов:

  • Включает фактическое содержимое в отчет

  • Сохраняет содержимое во внешний файл и добавляет ссылку к файлу в отчете

  • Встраивает содержимое как файл в отчете и добавляет ссылку к встроенному файлу

Таблица показывает, когда генератор отчетов включает, ссылки на, или встраивает содержимое, в зависимости от типа контента DocBlock, типа отчета и значений ConvertHTML и EmbedFile свойства.

Тип контента DocBlockСообщите о типеСвойство ConvertHTMLСвойство EmbedFileОтчет содержит
Содержимое DocBlockВнешняя ссылка к файлу содержимого DocBlockСоединитесь со встроенным файлом содержимого DocBlock
текстHTMLN/AN/Aданетнет
текстФАЙЛ HTMLN/AN/Aданетнет
текстWordN/AN/Aданетнет
текстPDFN/AN/Aданетнет
HTMLHTMLN/AN/Aданетнет
HTMLФАЙЛ HTMLN/AN/Aданетнет
HTMLPDFtRUEN/Aданетнет
HTMLPDFложьtRUEнетнетда
HTMLPDFложьложьнетданет
HTMLWordtRUEN/Aданетнет
HTMLWordложьN/Aнетданет
RTFPDFN/AtRUEнетнетда
RTFPDFN/Aложьнетданет
RTFWordN/AN/Aданетнет
RTFHTMLN/AtRUEнетнетда
RTFHTMLN/Aложьнетданет
RTFФАЙЛ HTMLN/AN/Aнетданет

slreportgen.report.DocBlock классом является handle класс.

Атрибуты класса

HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

rptr = slreportgen.report.DocBlock() создает пустой генератор отчетов DocBlock на основе шаблона по умолчанию. Настройте содержимое и формат сгенерированного содержимого при помощи свойств генератора отчетов. Прежде чем вы добавите генератор отчетов в отчет, необходимо задать DocBlock в Object свойство генератора отчетов. Добавление пустого генератора отчетов к отчету производит ошибку.

пример

rptr = slreportgen.report.DocBlock(docBlockObj) создает генератор отчетов DocBlock для DocBlock, заданного docBlockObj, который может быть путем DocBlock или указателем. Смотрите Object свойство.

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

Свойства

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

Блок Simulink DocBlock в виде строкового скаляра или вектора символов, который содержит путь к DocBlock или как указатель на блок DocBlock.

Примечание

Если вы используете средство поиска, чтобы найти блоки DocBlock и добавить результаты непосредственно в отчет, генераторы отчетов DocBlock используются, чтобы сообщить относительно блоков DocBlock, а не генераторов отчетов свойства объекта Simulink.

Импортировать ли содержимое простого текста в линии в виде true или false. Если ImportTextInline false, прежде чем генератор отчетов добавляет содержимое к отверстию, это переносит содержимое в один или несколько абзацев, в зависимости от значения TexSep свойство. Установите ImportTextInline к true добавлять текстовое содержимое DocBlock к отверстию в абзаце (встроенное отверстие).

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

ЗначениеОписание
"Ignore"Сверните текст в одиночном абзаце независимо от того, содержит ли он диафрагмы. (значение по умолчанию)
"LineFeed"Если текстовый сегмент заканчивается переводом строки, перенесите его в абзац.
"BlankLine"Если текстовый сегмент заканчивается пустой строкой, перенесите его в абзац.

Включать ли содержимое HTML в виде true или falseСвойство.This применяется только к отчетам PDF и Word.

Если значением является true, Содержимое HTML преобразовано в Объекты DOM и добавлено к отчету.

Если значением является false:

  • Для отчета PDF отчет встраивает содержимое или включает в себя внешнюю ссылку к содержимому, в зависимости от значения свойства EmbedFile.

  • Для отчета Word отчет включает в себя внешнюю ссылку к содержимому.

Если отчет является HTML или отчетом файла HTML, содержимое HTML включено в отчет, независимо от значения ConvertHTML свойство.

Встроить ли содержимое блока DocBlock в сгенерированном отчете в виде true или false. Это свойство применяется только к HTML или содержимому RTF с отчетами PDF и к содержимому RTF с отчетами HTML. Если значением является true, генератор отчетов встраивает содержимое DocBlock в отчет и вставляет гиперссылку на встроенный файл.

Объект средства форматирования абзаца, который форматирует простой текст если ImportTextInline свойством является falseВ виде mlreportgen.dom.Paragraph объект. Начальное значение ParagraphFormatter свойством является mlreportgen.dom.Paragraph объект со значениями свойств по умолчанию. Чтобы настроить внешний вид абзаца, измените mlreportgen.dom.Paragraph свойства объектов или замена объект с индивидуально настраиваемым mlreportgen.dom.Paragraph объект. Если вы добавляете содержимое в значение по умолчанию или заменяющий объект абзаца, содержимое появляется перед содержимым DocBlock в сгенерированном отчете.

Текстовый объект средства форматирования, который форматирует простой текст если ImportTextInline свойством является trueВ виде mlreportgen.dom.Text объект. Начальное значение TextFormatter свойством является mlreportgen.dom.Text объект со значениями свойств по умолчанию. Чтобы настроить внешний вид текста, измените mlreportgen.dom.Text свойства объектов или замена объект с индивидуально настраиваемым mlreportgen.dom.Text объект. Если вы добавляете содержимое в значение по умолчанию или заменяющий объект абзаца, содержимое появляется перед содержимым DocBlock в сгенерированном отчете.

Источник шаблона для этого генератора отчетов, заданного одним из этих способов:

  • Вектор символов или строковый скаляр, который задает путь файла, который содержит шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для Microsoft® Отчет Word, TemplateSrc должен быть шаблон генератора отчетов Word. Если TemplateSrc свойство пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.

Имя шаблона для этого генератора отчетов в виде вектора символов или строкового скаляра. Шаблон для этого генератора отчетов должен быть в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

Включайте содержимое от Sensor Info DocBlock slrgex_fuelsys модель в отчете путем добавления DocBlock генератор отчетов к отчету. Укажите, что абзацы в DocBlock разграничены переводом строки.

% Import the API package
import slreportgen.report.*
import mlreportgen.report.*

% Load the model
model_name = "slrgex_fuelsys";
load_system(model_name);
docBlock = "slrgex_fuelsys/To Controller/Sensor Info";

% Create a report 
rpt = slreportgen.report.Report("output","pdf");

% Create a chapter reporter
chapter = Chapter(docBlock);

% Create a DocBlock reporter
% Specify that paragraphs are delimited by a linefeed 
rptr = DocBlock(docBlock);
rptr.TextSep = "LineFeed";

% Add the DocBlock reporter to the chapter
% Add the chapter to the report
add(chapter, rptr);
add(rpt, chapter);

% Close and view the output report
close(rpt);
close_system(model_name);
rptview(rpt);

Вот содержимое от Sensor Info DocBlock in the generated report:

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

| |

Темы

Введенный в R2019b

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

Поддержка