Main Content

mlreportgen.dom.ErrorMessage Class

Namespace: mlreportgen.dom

Error message

Description

Specifies error message text originating from a specified source object.

The mlreportgen.dom.ErrorMessage class is a handle class.

Creation

Description

example

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.

Properties

expand all

Object identifier for mlreportgen.dom.ErrorMessage 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

Source DOM object from which the message originates.

Tag for mlreportgen.dom.ErrorMessage 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

Message text, specified as a character vector.

Methods

expand all

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:1497 opening
dom.Document:1497 parsing template "/mathworks/devel/bat/filer/batfs1904-0/Bdoc24a.2528353/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:1497 appended dom.TemplateText:1515
dom.Document:1497 appended dom.TemplateText:1518
dom.Document:1497 appended dom.TemplateText:1521
dom.Document:1497 moved to hole "#start#"
dispatch(dispatcher,ErrorMessage('invalid chapter',d));
dom.Document:1497 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:1497 appended chapter title
close(d);
dom.Document:1497 appended dom.TemplateText:1536
dom.Document:1497 moved to hole "#end#"
dom.Document:1497 closed
rptview(d.OutputPath);

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

delete(l);

Version History

Introduced in R2014b