mlreportgen.ppt.MessageDispatcher Class

Namespace: mlreportgen.ppt

PPT message dispatcher

Description

Dispatcher for presentation generation status messages.

Note

When you create a message dispatcher, the PPT 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.

The mlreportgen.ppt.MessageDispatcher class is a handle class.

Properties

Filter — Message filter

character vector | string scalar

Message filter that determines the types of messages the dispatcher dispatches, specified as a character vector or a string scalar. You can control the types of messages that are dispatched by setting the properties of the filter.

Attributes:

GetAccess	public
SetAccess	protected
NonCopyable	true
Transient	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The PPT 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 PPT API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public Methods

Method	Purpose
dispatch	Dispatch a presentation 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 presentation.

Create the presentation.

import mlreportgen.ppt.*;
pre = Presentation("myPresentation.pptx");

Create the listener and add it to the message dispatcher.

dispatcher = MessageDispatcher.getTheDispatcher;

dispatcher.Filter.ErrorMessagesPass = true;
dispatcher.Filter.ProgressMessagesPass = false;

l = addlistener(dispatcher,"Message", ...
@(src, evtdata) disp(evtdata.Message.formatAsText));

Create the message and dispatch it before opening.

msg = ErrorMessage("Invalid slide",pre);
dispatch(dispatcher, msg);

open(pre);

Create an error in the program and dispatch the message before opening the presentation.

titleText = Text("This is a Title");
titleText.Style = {Bold};
replace(pre,"Title",titleText);

close(pre);

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

delete(l);

Version History

Introduced in R2015b