mlreportgen.dom.WarningMessage Class

Namespace: mlreportgen.dom

Warning message

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.

Input Arguments

text — Message text

character vector | string scalar

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

source — DOM object from which 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	public
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 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);

Version History

Introduced in R2014b