Main Content

mlreportgen.ppt.ErrorMessage Class

Namespace: 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

example

errorMsgObj = ErrorMessage(text,sourceObject) creates an error 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

Properties

expand all

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

Attributes:

NonCopyable
true

Data Types: char | string

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 issues occur during presentation generation.

Attributes:

NonCopyable
true

Data Types: char | string

Source PPT object from which the message originates.

Message text, specified as a character vector.

Methods

expand all

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

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