本页采用了机器翻译。点击此处可查看最新英文版本。

mlreportgen.dom.MessageEventData 类

命名空间: mlreportgen.dom

保存触发消息事件的消息

全页展开

描述

包含触发消息事件的消息。

mlreportgen.dom.MessageEventData 类是一个 handle 类。

创建对象

描述

messageEventDataObj = MessageEventData(msg) 创建一个包含 DOM 消息（例如，mlreportgen.dom.ProgressMessage 类型的消息）的消息事件数据对象。

DOM 消息调度程序在调度消息时会将此类型的对象附加到消息事件。这使得消息事件侦听程序能够检索已发送的消息。仅当您想创建自己的消息调度程序时才需要创建此类型的实例。

示例

输入参量

全部展开

触发消息事件的消息对象，例如 mlreportgen.dom.ProgressMessage 对象。

属性

全部展开

此属性的值是一个 DOM 消息对象，例如 mlreportgen.dom.ProgressMessage 对象，该对象触发消息事件。

属性：

GetAccess
public
SetAccess
protected
NonCopyable
true
Transient
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

示例

全部折叠

当您添加调度程序时，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);

版本历史记录

在 R2014b 中推出

另请参阅

主题