Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

setCheckText

Class: ModelAdvisor.FormatTemplate
Package: ModelAdvisor

Add description of check to result

Syntax

setCheckText(ft_obj, text)

Description

setCheckText(ft_obj, text) is an optional method that adds text or a model advisor template object as the first item in the report. Use this method to add information describing the overall check.

Input Arguments

ft_obj

A handle to a template object.

text

A character vector or a handle to a formatting object.

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

text appears as the first line in the analysis result.

Examples

Create a list object, ft, and add a line of text to the result:

ft = ModelAdvisor.FormatTemplate('ListTemplate');
setCheckText(ft, ['Identify unconnected lines, input ports,'...
    'and output ports in the model']);

Was this topic helpful?