mlreportgen.dom.MessageDispatcher class

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

Диспетчер сообщений DOM

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

Описание

Диспетчер для сообщений о состоянии генерации документов.

Примечание

При создании диспетчера сообщений DOM API сохраняет диспетчера до конца текущего MATLAB® сеанс. Удалите прослушиватели событий сообщений, чтобы избежать дублирования отчетов об объектах сообщений во время сеанса работы с MATLAB.

Свойства

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

(Только для чтения) Значение этого свойства является фильтром, который определяет типы сообщений, которые отправляет диспетчер. Можно управлять, какие типы сообщений отправляются, задавая свойства фильтра.

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

Тег для этого элемента документа, заданный как вектор символов или строковый скаляр.

DOM генерирует тег с уникальным сеансом как часть создания этого объекта. Сгенерированный тег имеет форму CLASS: ID, где CLASS является классом объекта, а ID является значением Id свойство объекта. Определение собственного значения тега может помочь вам определить, где произошла проблема во время генерации документа.

Методы

Метод

Цель

dispatch

Отправка сообщения о состоянии генерации документов

mlreportgen.ppt.MessageDispatcher.getTheDispatcher

Получите диспетчера сообщений

Примеры

свернуть все

В этом примере показано, как добавить сообщение о прогрессе для отображения при генерации отчета.

Добавьте диспетчера и прослушивателя в отчет.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
d.Tag = 'My report';
          dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
    @(src,evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dispatch(dispatcher,ProgressMessage('starting chapter',d));
p = Paragraph('Chapter ');
p.Tag = 'chapter title';
append(d,p);
     
close(d);
rptview('test',doctype);

Удалите прослушиватель, чтобы избежать дублирования отчетов об объектах сообщений во время сеанса работы с MATLAB.

delete(l);

Проверьте сообщения о прогрессе в Командном окне MATLAB. The starting chapter появится сообщение в дополнение к предопределенным сообщениям о прогрессе DOM.

См. также

| | |

Темы

MATLAB Report Generator

Поддержка

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