mlreportgen.ppt.ProgressMessage Class

Namespace: mlreportgen.ppt

Progress message

Description

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

The mlreportgen.ppt.ProgressMessage class is a handle class.

Creation

Description

progressMsgObj = ProgressMessage(text,sourcePPTObject) creates a progress message with the specified text, originating from the specified source object.

Input Arguments

text — Message text

character vector | string scalar

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

sourceObject — PPT object from which message originates

a PPT object

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

Properties

Source — Source PPT object from which message originates

a PPT object

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

Text — Text of message

character vector | string scalar

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

Attributes:

Transient	true
NonCopyable	true

Data Types: char | string

Tag — Tag for mlreportgen.ppt.ProgressMessage object

character vector | string scalar

Tag for the mlreportgen.ppt.ProgressMessage 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

Id — Object identifier for mlreportgen.ppt.ProgressMessage object

character vector | string scalar

Object identifier for the mlreportgen.ppt.ProgressMessage 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

Public Methods

Method	Purpose
formatAsHTML	Wrap message in HTML tags.
formatAsText	Format message as text.
passesFilter	Determine if message passes filter.

Examples

Create a Progress Message

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

Version History

Introduced in R2015b