Exponenta Banner
exponenta event banner

класс mlreportgen.dom.StartEventData

Пакет: 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 свойства объекта. Указание собственного значения тега может помочь определить, где возникла проблема во время создания документа.

Примеры

свернуть все

При добавлении диспетчера 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

Поддержка