mlreportgen.ppt.ErrorMessage Class

Namespace: mlreportgen.ppt

Error message

Description

Specifies error message text originating from a specified source object.

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

Creation

Description

errorMsgObj = ErrorMessage(text,sourceObject) creates an error 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.

Attributes:

GetAccess	public
SetAccess	none
Transient	true
NonCopyable	true

Text — Text of message

character vector | string scalar

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

Attributes:

GetAccess	public
SetAccess	public
Transient	true
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, 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:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public 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

Create an Error Message

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

Version History

Introduced in R2015b