mlreportgen.ppt.DebugMessage class

Package: mlreportgen.ppt
Superclasses:

Debugging message

Description

Creates debugging message text originating from the specified source object.

Construction

debugMsgObj = DebugMessage(text,sourceObject) creates a debugging message with the specified text, originating from the specified source object.

Input Arguments

expand all

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

The PPT object from which the message originates, specified as a PPT object.

Output Arguments

expand all

Debug message, returned as an mlreportgen.ppt.DebugMessage object.

Properties

expand all

ID for PPT API object, specified as a character vector. A session-unique ID is generated as part of object creation. You can specify an ID to replace the generated ID.

Source PPT object from which the message originates.

Tag for this PPT API object, specified as a character vector. A session-unique tag is generated 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 presentation generation.

Message text, specified as a character vector.

Methods

Use DebugMessage methods similar to how you use ProgressMessage methods.

Method

Purpose

formatAsHTML

Format message as HTML.

formatAsText

Format message as text.

passesFilter

Determine whether message passes filter.

Examples

collapse all

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 the presentation.

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

open(pre);

Add content and close 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);

Introduced in R2015b