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.ProgressMessage class

Package: mlreportgen.ppt
Superclasses:

Progress message

Description

Create a progress message with the specified text originating from the specified source object.

Construction

progressMsgObj = ProgressMessage(text,sourcePPTObject) creates a progress 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

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

Message text, specified as a character vector.

Methods

Method

Purpose

formatAsHTML

Wrap message in HTML tags.

formatAsText

Format message as text.

passesFilter

Determine if message passes filter.

Examples

expand all

Create the presentation.

import mlreportgen.ppt.*;
pre = Presentation('myPresentation.pptx');

Create a message dispatcher.

dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

Dispatch the message.

open(pre);
dispatch(dispatcher,ProgressMessage('starting presentation',pre));

Add presentation content.

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

replace(pre,'Title',titleText);

Close the presentation and delete the listener.

close(pre);

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

delete(l);

Introduced in R2015b

Was this topic helpful?