mlreportgen.dom.MessageEventData class

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

Проводит сообщение, инициировавшее мероприятие сообщения

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

Описание

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

Конструкция

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

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

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

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

Объект сообщения, такой как mlreportgen.dom.ProgressMessage объект, который инициировал событие сообщения.

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

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

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

Свойства

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

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

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

Пометьте для этого элемента документа в виде вектора символов.

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

Примеры

свернуть все

Когда вы добавляете диспетчера, API DOM создает 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
Поддержка
Для просмотра документации необходимо авторизоваться на сайте