Exponenta Banner
exponenta event banner

класс slreportgen.report.DocBlock

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

DocBlock репортер

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

Описание

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

Примечание

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

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

% 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

Поддержка