Main Content

mlreportgen.dom.ProgressMessage Class

Namespace: mlreportgen.dom

Progress message

Description

Create a progress message with the specified text originating from the specified source object.

The mlreportgen.dom.ProgressMessage class is a handle class.

Creation

Description

progressMsgObj = ProgressMessage(text,sourceDOMObject) creates a progress message with the specified text, originating from the specified source object.

example

Input Arguments

expand all

The text to display for the message, specified as a character vector or string scalar..

The DOM object from which the message originates.

Properties

expand all

Source DOM object from which the message originates.

Attributes:

GetAccess
public
SetAccess
none
Transient
true

Message text, specified as a character vector or string scalar.

Attributes:

GetAccess
public
SetAccess
public
Transient
true
NonCopyable
true

Data Types: char | string

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

Create the report document.

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

Create a message dispatcher.

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

Dispatch the message.

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

Add report content.

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

Run report and delete the listener.

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

Delete the listener to avoid duplicate reporting of message objects during a MATLAB® session.

delete(l);

Version History

Introduced in R2014b