ModelAdvisor.Text

Create Model Advisor text output

Description

ModelAdvisor.Text objects create formatted text for the Model Advisor output.

Creation

Syntax

text = ModelAdvisor.Text(content,attribute)

Description

text = ModelAdvisor.Text(content,attribute) creates a text object for the Model Advisor output.

Input Arguments

content — Text object content

character vector

Optional character vector specifying the content of the text object. If content is empty, empty text is output.

attribute — Optional cell array

normal (default) | character vector | cell array of character vectors

Optional cell array of character vectors specifying the formatting of the content. If attribute is empty, the output text has the default coloring. Possible formatting options include:

• normal (default) — Text is black and unformatted.

• bold — Text is bold.

• italic — Text is italicized.

• underline — Text is underlined.

• pass — Text is green.

• warn — Text is yellow.

• fail — Text is red.

• keyword — Text is blue.

• subscript — Text is subscripted.

• superscript — Text is superscripted.

Add ASCII and Extended ASCII characters using the MATLAB^® char command.

Object Functions

setBold	Specify bold text in Model Advisor analysis results
setColor	Specify text color in Model Advisor analysis results
setHyperlink	Specify hyperlinked text
setItalic	Specify italic text in Model Advisor analysis results
setRetainSpaceReturn	Retain spacing and returns in text
setSubscript	Specify subscripted text
setSuperscript	Specify superscripted text
setUnderlined	Underline text

Examples

Specify Text in the Model Advisor Output

Text is the simplest form of output. You can format text in many different ways.

When you want one type of formatting for all text, use this syntax:

ModelAdvisor.Text(content, {attributes})

To apply multiple types of formatting, you must create several text objects and combine them.

t1 = ModelAdvisor.Text('It is ');
t2 = ModelAdvisor.Text('recommended', {'italic'});
t3 = ModelAdvisor.Text(' to use same font for ');
t4 = ModelAdvisor.Text('blocks', {'bold'});
t5 = ModelAdvisor.Text(' for a uniform appearance in the model.');

result = ([t1, t2, t3, t4, t5]); 

Here is an example of a simple check callback function using the Model Advisor Formatting APIs:

function result = SampleStyleOneCallback(system)
mdladvObj = Simulink.ModelAdvisor.getModelAdvisor(system);
if strcmp(get_param(bdroot(system), 'ScreenColor'),'white')
   result = ModelAdvisor.Text('Passed',{'pass'});
   mdladvObj.setCheckResultStatus(true); 
else
   msg1 = ModelAdvisor.Text(...
       ['It is recommended to select a Simulink window screen color'...
       ' of white for a readable and printable model. Click ']);
   msg2 = ModelAdvisor.Text('here');
   msg2.setHyperlink('matlab: set_param(bdroot,''ScreenColor'',''white'')');
   msg3 = ModelAdvisor.Text(' to change screen color to white.');
   result = [msg1, msg2, msg3];
   mdladvObj.setCheckResultStatus(false); 
end 

Version History

Introduced in R2006b