mlreportgen.ppt.WarningMessage class

Package: mlreportgen.ppt
Superclasses:

Warning message

Description

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

Construction

warningMsgObj = WarningMessage(text,source) creates a warning 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

Warning message, returned as an mlreportgen.ppt.WarningMessage 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, specified as a PPT object.

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

Use WarningMessage methods similar to how you use ProgressMessage methods.

Method

Purpose

formatAsHTML

Wrap message in HTML tags.

formatAsText

Format message as text.

passesFilter

Determine if message passes filter.

Examples

collapse all

import mlreportgen.ppt.*;
pre = Presentation('myPresentation.pptx');
     
dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));
     
open(pre);
dispatch(dispatcher,WarningMessage('invalid slide',pre));

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

replace(pre,'Title',titleText);

close(pre);

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

delete(l);

Introduced in R2015b