mlreportgen.dom.ProgressMessage class

Package: mlreportgen.dom
Superclasses:

Progress message

Description

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

Construction

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.

Properties

expand all

ID for this document element, specified as a character vector or string scalar. 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 this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Message text, specified as a character vector.

Methods

Method

Purpose

formatAsHTML

Wrap message in HTML tags.

formatAsText

Format message as text.

passesFilter

Determine if message passes filter.

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:95 opening
dom.Document:95 parsing template "/mathworks/devel/bat/Bdoc20b/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:95 appended dom.TemplateText:111
dom.Document:95 appended dom.TemplateText:114
dom.Document:95 appended dom.TemplateText:117
dom.Document:95 moved to hole "#start#"
dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:95 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:95 appended chapter title

Run report and delete the listener.

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

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

delete(l);