mlreportgen.dom.WarningMessage class

Package: mlreportgen.dom
Superclasses:

Warning message

Description

Create a warning message with the specified text originating from the specified source object.

Construction

warningMsgObj = WarningMessage(text,source) creates a warning message with the specified text originating from the specified source object.

Input Arguments

text — Message text

character vector

The text to display for the message.

source — DOM object from which message originates

a DOM object

The DOM object from which the message originates.

Output Arguments

warningMsgObj — Warning message

mlreportgen.dom.WarningMessage object

Warning message, represented by an mlreportgen.dom.WarningMessage 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 DOM object from which 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 WarningMessage methods similar to how you use ProgressMessage methods.

Method	Purpose
formatAsHTML	Wrap message in HTML tags.
formatAsText	Format message as text.
passesFilter	Determine if message passes filter.

Examples

Create a Warning Message

import mlreportgen.dom.*;
d = Document('test','html');
     
dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dispatch(dispatcher,WarningMessage('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);

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

delete(l);