mlreportgen.dom.ErrorMessage Class

R2026b

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

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 | string scalar

The text to display for the message, specified as a character vector or string scalar..

sourceObject — The DOM object from which the 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.

Attributes:

GetAccess	public
SetAccess	none
Transient	true

Text — Text of message

character vector | string scalar

Message text, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	none
Transient	true
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public 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

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

import mlreportgen.dom.*;
d = Document("test","html");

dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,"Message", ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

open(d);

dom.Document:112 opening
dom.Document:112 parsing template "/mathworks/devel/bat/filer/batfs2566-0/Bdoc.3258532/build/runnable/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:112 appended dom.TemplateText:131
dom.Document:112 appended dom.TemplateText:134
dom.Document:112 appended dom.TemplateText:137
dom.Document:112 moved to hole "#start#"

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

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

close(d);

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