主要内容

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

mlreportgen.dom.ProgressMessage 类

命名空间: mlreportgen.dom

进度消息

描述

创建来自指定源对象的具有指定文本的进度消息。

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

创建对象

描述

progressMsgObj = ProgressMessage(text,sourceDOMObject) 创建一个具有指定文本的进度消息,源自指定的源对象。

示例

输入参量

全部展开

要显示的消息文本,指定为字符向量或字符串标量。

消息源自的 DOM 对象。

属性

全部展开

消息源自的源 DOM 对象。

属性:

GetAccess
public
SetAccess
Transient
true

消息文本,指定为字符向量或字符串标量。

属性:

GetAccess
public
SetAccess
public
Transient
true
NonCopyable
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.*;
d = Document('test','html');

创建消息调度程序。

dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

发送消息。

open(d);
dom.Document:195 opening
dom.Document:195 parsing template "/mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2864802/build/runnable/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:195 appended dom.TemplateText:213
dom.Document:195 appended dom.TemplateText:216
dom.Document:195 appended dom.TemplateText:219
dom.Document:195 moved to hole "#start#"
dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:195 starting chapter

添加报告内容。

p = Paragraph('Chapter ');
p.Tag = 'chapter title';
p.Style = { CounterInc('chapter'),...
    CounterReset('table'),WhiteSpace('pre') };
append(p, AutoNumber('chapter'));
append(d,p);
dom.Document:195 appended chapter title

运行报告并删除侦听程序。

close(d);
dom.Document:195 appended dom.TemplateText:234
dom.Document:195 moved to hole "#end#"
dom.Document:195 closed
rptview('test','html');

删除侦听程序以避免在 MATLAB® 会话期间重复报告消息对象。

delete(l);

版本历史记录

在 R2014b 中推出