mlreportgen.ppt.ErrorMessage class

Package: mlreportgen.ppt

Error message

Description

Specifies error message text originating from a specified source object.

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

Creation

Description

errorMsgObj = ErrorMessage(text,sourceObject) creates an error message with the specified text originating from the specified source object.

Input Arguments

text — Message text

character vector

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

sourceObject — The PPT object from which message originates

a PPT object

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

Properties

Id — ID for this PPT API object

character vector | string scalar

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

Tag — Tag for this PPT API object

character vector | string scalar

Tag for this PPT API object, specified as a character vector or string scalar. 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.

Source — Source object from which the message originates

a PPT object

Source PPT object from which the message originates.

Text — Text of message

character vector

Message text, specified as a character vector.

Methods

Public Methods

Use ErrorMessage 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

Create an Error Message

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

Add an error to the program.

titleText = Text('This is a Title');
titleText.Style = {Bold};

replace(presentation,'Title',titleText);

Create the message and dispatch it. Then open the presentation.

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

open(pre);

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

delete(l);

Version History

Introduced in R2015b