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

expand all

The text to display for the message.

The DOM object from which the message originates.

Output Arguments

expand all

Error message, represented by an mlreportgen.dom.ErrorMessage 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.

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

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

collapse all

import mlreportgen.dom.*;
d = Document('test','html');
     
dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dom.Document:354 opening
dom.Document:354 parsing template "/mathworks/devel/bat/Bdoc20a/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:354 appended dom.TemplateText:370
dom.Document:354 appended dom.TemplateText:373
dom.Document:354 appended dom.TemplateText:376
dom.Document:354 moved to hole "#start#"
dispatch(dispatcher,ErrorMessage('invalid chapter',d));
dom.Document:354 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:354 appended chapter title
close(d);
dom.Document:354 appended dom.TemplateText:391
dom.Document:354 moved to hole "#end#"
dom.Document:354 closed
rptview(d.OutputPath);

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

delete(l);