setSubResultStatusText

Add text below the check or subcheck status in Model Advisor analysis results

Syntax

setSubResultStatusText(ftObj,message)

Description

setSubResultStatusText(ftObj,message) is an optional method that displays text below the result status in the report generated by the Model Advisor formatting object ftObj. Use message to describe the status.

Examples

Add status message below subcheck result in Model Advisor results

This example shows how to display a status message below a subcheck result in the Model Advisor results.

Create a list template object.

ft = ModelAdvisor.FormatTemplate("ListTemplate");

Set the result status to pass.

setSubResultStatus(ft,'pass');

Add a status message below the result.

setSubResultStatusText(ft,"All checks passed successfully.");

Input Arguments

ftObj — Model Advisor template object

ModelAdvisor.FormatTemplate object

ModelAdvisor.FormatTemplate object, specified as a handle to the formatting template.

message — Status text

character vector | string scalar

Displays status information below the result.

Example: "Conditional input branch"

Version History

Introduced in R2009a