This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

mlreportgen.dom.ProgressMessage class

Package: mlreportgen.dom

Progress message


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


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

Input Arguments

expand all

The text to display for the message.

The DOM object from which the message originates.

Output Arguments

expand all

Progress message, represented by an mlreportgen.dom.ProgressMessage object.


expand all

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Source DOM object from which the message originates.

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Message text, specified as a character vector.





Wrap message in HTML tags.


Format message as text.


Determine if message passes filter.


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.

dom.Document:797 opening
dom.Document:797 parsing template "/mathworks/devel/bat/Bdoc19a/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:797 appended dom.TemplateText:813
dom.Document:797 appended dom.TemplateText:816
dom.Document:797 appended dom.TemplateText:819
dom.Document:797 moved to hole "#start#"
dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:797 starting chapter

Add report content.

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

Run report and delete the listener.

dom.Document:797 appended dom.TemplateText:834
dom.Document:797 moved to hole "#end#"
dom.Document:797 closed

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