slreportgen.report.DocBlock class

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

DocBlock репортер

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

Описание

Используйте объект slreportgen.report.DocBlock класс для отчета по блоку DocBlock.

Примечание

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

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

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

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

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

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

Тип содержимого DocBlockТип отчетаСвойство ConvertHTMLСвойство EmbedFileОтчет содержит
Содержимое DocBlockВнешняя ссылка на файл содержимого DocBlockСсылка на файл содержимого Embedded DocBlock
текстHTMLН/ДН/Дданетнет
текстHTML-ФАЙЛН/ДН/Дданетнет
текстWordН/ДН/Дданетнет
текстPDFН/ДН/Дданетнет
HTMLHTMLН/ДН/Дданетнет
HTMLHTML-ФАЙЛН/ДН/Дданетнет
HTMLPDFправдаН/Дданетнет
HTMLPDFложныйправданетнетда
HTMLPDFложныйложныйнетданет
HTMLWordправдаН/Дданетнет
HTMLWordложныйН/Днетданет
RTFPDFН/Дправданетнетда
RTFPDFН/Дложныйнетданет
RTFWordН/ДН/Дданетнет
RTFHTMLН/Дправданетнетда
RTFHTMLН/Дложныйнетданет
RTFHTML-ФАЙЛН/ДН/Днетданет

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

Примечание

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

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

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

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

Включать ли HTML содержимого, заданные как true или falseЭто свойство применяется только к отчетам Word и PDF.

Если значение trueHTML содержимого преобразуется в объекты 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® Отчет о словах, TemplateSrc должен быть шаблоном репортера Word. Если на TemplateSrc свойство пусто, этот репортер использует шаблон репортера по умолчанию для типа выхода отчета.

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

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

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

% Load the model
model_name = 'sldemo_fuelsys';
load_system(model_name);
docBlock = 'sldemo_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

Поддержка

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