Exponenta Banner

mlreportgen.dom.MessageEventData class

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

Содержит событие запуска сообщения

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

Описание

Содержит сообщение, инициировавшее событие сообщения.

Конструкция

messageEventDataObj = MessageEventData(msg) создает объект данных о событиях сообщений, который содержит сообщение DOM (для примера - сообщение типа mlreportgen.dom.ProgressMessage).

Диспетчер сообщений DOM присоединяет объект этого типа к событию сообщения при отправке сообщения. Это позволяет прослушивателям событий сообщений извлекать отправленное сообщение. Создание образцов этого типа требуется только при необходимости создания собственного диспетчера сообщений.

Входные параметры

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

Объект сообщения, такой как mlreportgen.dom.ProgressMessage объект, который запускает событие сообщения.

Выходные аргументы

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

Контейнер для сообщений, инициирующих данные о событиях сообщения, представленный mlreportgen.dom.MessageEventData объект.

Свойства

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

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

Значение этого свойства только для чтения является объектом сообщения DOM, таким как mlreportgen.dom.ProgressMessage объект, который запускает событие сообщения.

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

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

Примеры

свернуть все

Когда вы добавляете диспетчера, DOM API создает evtdata объект, который является mlreportgen.dom.MessageEventData объект.

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';
p.Style = { CounterInc('chapter'), CounterReset('table'), WhiteSpace('pre') };
append(p, AutoNumber('chapter'));
append(d, p);
     
close(d);
rptview('test', doctype);

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

delete(l);

См. также

Темы

MATLAB Report Generator

Поддержка