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
Input Arguments
text
— Message text
character vector | string scalar
The text to display for the message, specified as a character vector or string scalar..
source
— DOM object from which message originates
a DOM object
The DOM object from which the message originates.
Properties
Source
— Source DOM object from which message originates
a DOM object
Source DOM object from which the message originates.
Text
— Text of message
character vector | string scalar
Message text, specified as a character vector or string scalar.
Attributes:
Transient | true |
NonCopyable | true |
Data Types: char
| string
Tag
— Tag for mlreportgen.dom.ProgressMessage
object
character vector | string scalar
Tag for the mlreportgen.dom.ProgressMessage
object, 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. Specify your own tag value to help
you identify where to look when an issue occurs during document generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Id
— Object identifier for mlreportgen.dom.ProgressMessage
object
character vector | string scalar
Object identifier for the mlreportgen.dom.ProgressMessage
object, specified as a
character vector or string scalar. The DOM API generates a session-unique identifier
when it creates the document element object. You can specify your own value for
Id
.
Attributes:
NonCopyable | true |
Data Types: char
| string
Methods
Public Methods
Method | Purpose |
---|---|
Wrap message in HTML tags. | |
Format message as text. | |
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:1450 opening dom.Document:1450 parsing template "/mathworks/devel/bat/filer/batfs2561-0/Bdoc24b.2679053/build/runnable/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx" dom.Document:1450 appended dom.TemplateText:1468 dom.Document:1450 appended dom.TemplateText:1471 dom.Document:1450 appended dom.TemplateText:1474 dom.Document:1450 moved to hole "#start#"
dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:1450 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:1450 appended chapter title
Run report and delete the listener.
close(d);
dom.Document:1450 appended dom.TemplateText:1489 dom.Document:1450 moved to hole "#end#" dom.Document:1450 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
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)