mlreportgen.dom.ProgressMessage class

Package: 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.

Input Arguments

text — Message text

character vector

The text to display for the message.

source — DOM object to from which message originates

a DOM object

The DOM object from which the message originates.

Properties

Id — ID for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Source — Source DOM object message originates from

a DOM object

Source DOM object from which the message originates.

Tag — Tag for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Text — Text of message

character vector

Message text, specified as a character vector.

Methods

Public Methods

Method	Purpose
formatAsHTML	Wrap message in HTML tags.
formatAsText	Format message as text.
passesFilter	Determine if message passes filter.

Examples

Create a Progress Message

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:187 opening
dom.Document:187 parsing template "/mathworks/devel/bat/Bdoc23b/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:187 appended dom.TemplateText:203
dom.Document:187 appended dom.TemplateText:206
dom.Document:187 appended dom.TemplateText:209
dom.Document:187 moved to hole "#start#"

dispatch(dispatcher,ProgressMessage('starting chapter',d));

dom.Document:187 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:187 appended chapter title

Run report and delete the listener.

close(d);

dom.Document:187 appended dom.TemplateText:224
dom.Document:187 moved to hole "#end#"
dom.Document:187 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