Documentation Center

  • Trial Software
  • Product Updates

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 string 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']);

See Also

How To

Was this topic helpful?