mlreportgen.dom.DebugMessage 类

命名空间: mlreportgen.dom

调试消息

全页展开

描述

创建源自指定源对象的调试消息文本。

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

创建对象

描述

debugMsgObj = DebugMessage(text,sourceObject) 使用指定的文本创建一条调试消息，源自指定的源对象。

示例

输入参量

全部展开

`text` — 消息文本
字符向量

消息中要显示的文本。

`sourceObject` — 消息来源的 DOM 对象
DOM 对象

消息源自的 DOM 对象。

属性

全部展开

`Id` — `mlreportgen.dom.DebugMessage` 对象的标识符
字符向量 | 字符串标量

mlreportgen.dom.DebugMessage 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable true

数据类型: char | string

`Source` — 源对象消息源自
DOM 对象

消息源自的源 DOM 对象。

`Tag` — `mlreportgen.dom.DebugMessage` 对象的标签
字符向量 | 字符串标量

mlreportgen.dom.DebugMessage 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable true

数据类型: char | string

`Text` — 消息文本
字符向量

消息文本，指定为字符向量。

方法

全部展开

公共方法

使用 DebugMessage 方法的方式与使用 ProgressMessage 方法的方式类似。

方法	用途
`formatAsHTML`	将消息格式化为 HTML。
`formatAsText`	将消息格式化为文本。
`passesFilter`	确定消息是否通过过滤器。

示例

全部折叠

创建调试消息

创建报告文档。

import mlreportgen.dom.*;
d = Document("test","html");

创建侦听程序并将其添加到消息调度程序。

dispatcher = MessageDispatcher.getTheDispatcher;
dispatcher.Filter.DebugMessagesPass = true;

l = addlistener(dispatcher,"Message", ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

添加报告内容。

open(d);

p = Paragraph("Chapter ");
p.Tag = "chapter title";
p.Style = {CounterInc("chapter"),...
    CounterReset("table"),WhiteSpace("pre") };
append(p,AutoNumber("chapter"));
append(d,p);

生成报告。