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. 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 the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier 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:33 opening
dom.Document:33 parsing template "/mathworks/devel/bat/Bdoc19b/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:33 appended dom.TemplateText:49
dom.Document:33 appended dom.TemplateText:52
dom.Document:33 appended dom.TemplateText:55
dom.Document:33 moved to hole "#start#"
dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:33 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:33 appended chapter title

Run report and delete the listener.

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

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

delete(l);