Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

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. 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 document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

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

expand all

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

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

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

close(d);
rptview(d.OutputPath);
dom.Document:119 opening
dom.Document:119 parsing template "/mathworks/devel/bat/Bdoc17b/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:119 appended dom.TemplateText:135
dom.Document:119 appended dom.TemplateText:138
dom.Document:119 appended dom.TemplateText:141
dom.Document:119 moved to hole "#start#"
dom.Document:119 invalid chapter
dom.Document:119 appended chapter title
dom.Document:119 appended dom.TemplateText:156
dom.Document:119 moved to hole "#end#"
dom.Document:119 closed

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

delete(l);
Was this topic helpful?