Main Content

mlreportgen.dom.WarningMessage Class

Namespace: mlreportgen.dom

Warning message

expand all in page

Description

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

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

Creation

Description

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

example

Input Arguments

expand all

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

The DOM object from which the message originates.

Properties

expand all

Source DOM object from which the message originates.

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

Attributes:

Transient
true
NonCopyable
true

Data Types: char | string

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

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

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);
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);

Version History

Introduced in R2014b

See Also

Topics