mlreportgen.dom.MessageDispatcher class

Package: mlreportgen.dom
Superclasses:

DOM message dispatcher

Description

Dispatcher for document generation status messages.

Note

When you create a message dispatcher, the DOM API keeps the dispatcher until the end of the current MATLAB^® session. Delete message event listeners to avoid duplicate reporting of message objects during a MATLAB session.

Properties

Filter — Message filter

character vector

(Read-only) The value of this property is a filter that determines the types of messages the dispatcher dispatches. You can control which types of messages are dispatched by setting the properties of the filter.

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.

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.

Methods

Method	Purpose
dispatch	Dispatch a document generation status message
mlreportgen.ppt.MessageDispatcher.getTheDispatcher	Get the message dispatcher

Examples

Add and Dispatch a Progress Message

This example shows how to add a progress message to display when generating a report.

Add a dispatcher and listener to the report.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
d.Tag = 'My report';
          dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
    @(src,evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dispatch(dispatcher,ProgressMessage('starting chapter',d));
p = Paragraph('Chapter ');
p.Tag = 'chapter title';
append(d,p);
     
close(d);
rptview('test',doctype);

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

delete(l);

Check the progress messages in the MATLAB Command Window. The starting chapter message appears, in addition to the predefined DOM progress messages.