Documentation Center

  • Trial Software
  • Product Updates

setSubResultStatusText

Class: ModelAdvisor.FormatTemplate
Package: ModelAdvisor

Add text below status in result

Syntax

setSubResultStatusText(ft_obj, message)

Description

setSubResultStatusText(ft_obj, message) is an optional method that displays text below the status in the result. Use this method to describe the status.

Input Arguments

ft_obj

A handle to a template object.

message

A string or a handle to a formatting object that the Model Advisor displays below the status in the report.

Valid formatting objects are: ModelAdvisor.Image, ModelAdvisor.LineBreak, ModelAdvisor.List, ModelAdvisor.Paragraph, ModelAdvisor.Table, and ModelAdvisor.Text.

Examples

Create a list object, ft, add a passing status and a description of why the check passed:

ft = ModelAdvisor.FormatTemplate('ListTemplate');
setSubResutlStatus(ft, 'Pass');
setSubResultStatusText(ft, ['Constructs that are not supported when '...
    'generating code were not found in the model or subsystem']);

See Also

How To

Was this topic helpful?