mlreportgen.dom.ErrorMessage class
Package: mlreportgen.dom
Superclasses:
Error message
Description
Specifies error message text originating from a specified source object.
Construction
creates
an error message with the specified text originating from the specified
source object.errorMsgObj
= ErrorMessage(text
,sourceObject
)
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 |
---|---|
Format message as HTML. | |
Format message as text. | |
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:232 opening dom.Document:232 parsing template "/mathworks/devel/bat/Bdoc22a/build/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx" dom.Document:232 appended dom.TemplateText:248 dom.Document:232 appended dom.TemplateText:251 dom.Document:232 appended dom.TemplateText:254 dom.Document:232 moved to hole "#start#"
dispatch(dispatcher,ErrorMessage('invalid chapter',d));
dom.Document:232 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:232 appended chapter title
close(d);
dom.Document:232 appended dom.TemplateText:269 dom.Document:232 moved to hole "#end#" dom.Document:232 closed
rptview(d.OutputPath);
Delete the listener to avoid duplicate reporting of message objects during a MATLAB® session.
delete(l);
Abrir ejemplo
Tiene una versión modificada de este ejemplo. ¿Desea abrir este ejemplo con sus modificaciones?
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)