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
creates an error message with the specified text originating from the
specified source object.errorMsgObj
= ErrorMessage(text
,sourceObject
)
Input Arguments
text
— Message text
character vector
The text to display for the message, specified as a character vector.
sourceObject
— The PPT object from which message originates
a PPT object
The PPT object from which the message originates, specified as a PPT object
Properties
Id
— ID for this PPT API object
character vector | string scalar
ID for this PPT API object, specified as a character vector or string scalar. A session-unique ID is generated as part of the object creation. You can specify an ID to replace the generated ID.
Attributes:
NonCopyable | true |
Data Types: char
| string
Tag
— Tag for this PPT API object
character vector | string scalar
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 issues occur during presentation generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Source
— Source object from which the message originates
a PPT object
Source PPT object from which the message originates.
Text
— Text of message
character vector
Message text, specified as a character vector.
Methods
Public Methods
Use ErrorMessage
methods similar to how you use
ProgressMessage
methods.
Method | Purpose |
---|---|
Format message as HTML. | |
Format message as text. | |
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
MATLAB-Befehl
Sie haben auf einen Link geklickt, der diesem MATLAB-Befehl entspricht:
Führen Sie den Befehl durch Eingabe in das MATLAB-Befehlsfenster aus. Webbrowser unterstützen keine MATLAB-Befehle.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)