mlreportgen.ppt.ProgressMessage class

Package: mlreportgen.ppt
Superclasses:

Progress message

expand all in page

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

Source PPT object from which the message originates.

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.

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

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

See Also

|

Topics

Introduced in R2015b

MATLAB Report Generator Documentation

Support