Main Content

mlreportgen.ppt.ErrorMessage Class

Namespace: mlreportgen.ppt

Error message

expand all in page

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.

example

Input Arguments

expand all

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

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

Properties

expand all

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

Message text, specified as a character vector or string scalar.

Attributes:

Transient
true
NonCopyable
true

Data Types: char | string

Tag for the mlreportgen.ppt.ErrorMessage object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for the mlreportgen.ppt.ErrorMessage object, 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:

NonCopyable
true

Data Types: char | string

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

See Also

|

Topics