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

mlreportgen.dom.MessageDispatcher 类

命名空间: mlreportgen.dom

DOM 消息调度程序

全页展开

描述

文档生成状态消息的调度程序。

注意

当您创建消息调度程序时，DOM API 会保留该调度程序直到当前 MATLAB® 会话结束。删除消息事件侦听程序，以避免在 MATLAB 会话期间重复报告消息对象。

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

属性

全部展开

消息过滤器，用于确定调度程序调度的消息类型，指定为字符向量或字符串标量。您可以通过设置过滤器的属性来控制发送的消息类型。

属性：

GetAccess
public
SetAccess
protected
NonCopyable
true
Transient
true

数据类型: char | string

标记，指定为字符向量或字符串标量。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

方法

全部展开

示例

全部折叠

此示例显示如何添加在生成报告时显示的进度消息。

向报告添加调度程序和侦听程序。

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 命令行窗口中的进度消息。除了预定义的 DOM 进度消息之外，还会出现 starting chapter 消息。

版本历史记录

在 R2014b 中推出

另请参阅

| | |

主题