Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.ppt.ErrorMessage class

Package: mlreportgen.ppt
Superclasses:

Error message

Description

Specifies error message text originating from a specified source object.

Construction

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

Output Arguments

expand all

Error message, returned as an mlreportgen.ppt.ErrorMessage 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.

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

An example of a reason for specifying your own tag value is to make it easier to identify where an issue occurred during presentation generation.

Source PPT object from which the message originates.

Message text, specified as a character vector.

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

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

Introduced in R2015b

Was this topic helpful?