User`s guide

25 Create Model Advisor Checks
25-44
Format Model Advisor Results
• “Overview of Displaying Results” on page 25-44
• “Format Model Advisor Results” on page 25-44
• “Format Text” on page 25-45
• “Format Lists” on page 25-45
• “Format Tables” on page 25-45
• “Format Paragraphs” on page 25-47
• “Formatted Output” on page 25-47
Overview of Displaying Results
You can make the analysis results of your custom checks appear similar to each other
with minimal scripting using the Model Advisor ModelAdvisor.FormatTemplate
class, as described in ModelAdvisor.FormatTemplate. For examples of callback
functions using the ModelAdvisor.FormatTemplate class, see “Simple Check Callback
Function” on page 25-38.
If this format template does not meet your needs, or if you want to format action results,
use the Model Advisor Formatting API, as described in the following sections.
Format Model Advisor Results
Use the Model Advisor Formatting API to produce formatted outputs in the Model
Advisor. The following constructors of the ModelAdvisor class provide the ability to
format the output. For more information on each constructor and associated methods, in
the Constructor column, click the link.
Constructor Description
ModelAdvisor.Text Formats element text.
ModelAdvisor.Paragraph Combines elements into paragraphs.
ModelAdvisor.List Creates a list of elements.
ModelAdvisor.LineBreak Adds a line break between elements.
ModelAdvisor.Table Creates a table.
ModelAdvisor.Image Adds an image to the output.