setSubTitle

Class: ModelAdvisor.FormatTemplate
Package: ModelAdvisor

Add title for subcheck in result

Syntax

setSubTitle(ft_obj, title)

Description

setSubTitle(ft_obj, title) is an optional method that adds a subcheck result title. Use this method when you create subchecks to distinguish between them in the result.

Input Arguments

ft_obj

A handle to a template object.

title

A string or a handle to a formatting object specifying the title of the subcheck.

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

Examples

Create a list object, ft, and add a subcheck title:

ft = ModelAdvisor.FormatTemplate('ListTemplate');
setSubTitle(ft, ['Check for constructs in the model '...
    'that are not supported when generating code']);
Was this topic helpful?