mlreportgen.dom.ErrorMessage class

Package: mlreportgen.dom
Superclasses:

Error message

Description

Specifies error message text originating from a specified source object.

Construction

errorMsgObj = ErrorMessage(text,sourceObject) creates an error 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.

sourceObject — The DOM object from which the message originates

a DOM object

The DOM object from which the message originates.

Output Arguments

errorMsgObj — Error message

mlreportgen.dom.ErrorMessage object

Error message, represented by an mlreportgen.dom.ErrorMessage object.

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.

Source — Source object from which the message originates

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.

Text — Text of message

character vector

Message text, specified as a character vector.

Methods

Use ErrorMessage methods similar to how you use ProgressMessage methods.

Method	Purpose
formatAsHTML	Format message as HTML.
formatAsText	Format message as text.
passesFilter	Determine whether message passes filter.

Examples

Create an Error Message

import mlreportgen.dom.*;
d = Document('test','html');
     
dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));
     
open(d);

dom.Document:265 opening
dom.Document:265 parsing template "/mathworks/devel/bat/Bdoc21b/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:265 appended dom.TemplateText:281
dom.Document:265 appended dom.TemplateText:284
dom.Document:265 appended dom.TemplateText:287
dom.Document:265 moved to hole "#start#"

dispatch(dispatcher,ErrorMessage('invalid chapter',d));

dom.Document:265 invalid chapter

p = Paragraph('Chapter ');
p.Tag = 'chapter title';
p.Style = {CounterInc('chapter'),...
    CounterReset('table'),WhiteSpace('pre')};
append(p,AutoNumber('chapter'));
append(d,p);

dom.Document:265 appended chapter title

close(d);

dom.Document:265 appended dom.TemplateText:302
dom.Document:265 moved to hole "#end#"
dom.Document:265 closed

rptview(d.OutputPath);

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

delete(l);