Work with Components

Insert and edit components in setup file to define report structure and content

Components are MATLAB^® objects that specify the content of a report. Add components to a setup file to specify the types of content and the structure for a report. For details, see Components.

Report Components

expand all

Report Structure Components

`Title Page`	Insert title page at beginning of report
`Chapter/Subsection`	Group portions of report into sections with titles
`Paragraph`	Insert paragraph text into report
`Text`	Format and insert text into report
`Code`	Insert text formatted as code in a paragraph
`Preformatted`	Insert preformatted paragraph
`HTML Text`	Insert HTML-formatted text into reports generated from a template
`Line Break`	Insert a line break
`Page Break`	Insert a page break
`List`	Create bulleted or numbered list from cell array or child components
`Link`	Insert linking anchors or pointers into report
`Image`	Insert image from external file into report
`Insert Variable`	Insert variable values into report
`Figure Snapshot`	Insert snapshot of Handle Graphics figure into report
`Axes Snapshot`	Insert image of selected MATLAB axes objects into the generated report
`MATLAB Toolbox Version Number`	Insert table that shows version and release numbers and release date of MathWorks products
`Nest Setup File`	Allow one report setup file (`rpt` file) to run inside another
`Empty Component`	Group components to move, activate, or deactivate them, or create blank space in list
`Import File`	Import ASCII text file into report

Handle Graphics Components

`Handle Graphics Linking Anchor`	Designate location to which links point
`Handle Graphics Name`	Insert name of Handle Graphics object into the report
`Handle Graphics Parameter`	Insert property name/property value pair from Handle Graphics figure, axes, or other object

Table Formatting Components

`Table`	Insert parent of table
`Array-Based Table`	Convert rectangular array into table and insert it into report
`Variable Table`	Insert table that displays all the variables in the MATLAB workspace
`Table Body`	Insert parent of table body
`Table Column Specification`	Specify table column properties
`Table Entry`	Insert table entry
`Table Footer`	Insert parent of table footer
`Table Header`	Insert parent of table header
`Table Row`	Insert parent of table row entries

Property Table Components

`MATLAB Property Table`	Insert table that includes MATLAB object property name/property value pairs
`Handle Graphics Property Table`	Insert table that reports on property name/property value pairs

Summary Table Components

Handle Graphics Summary Table Insert table that summarizes Handle Graphics object properties

Logical and Looping Components

`For Loop`	Iteratively execute child components
`While Loop`	Iteratively execute child components while a specified condition is true
`Logical If`	Specify `logical if` condition
`Logical Then`	Specify a `then` condition for a `Logical If` component
`Logical Else`	Specify an `else` condition for a `Logical If` component
`Logical Elseif`	Specify an `elseif` condition for a `Logical If` component
`Graphics Object Loop`	Run child components for each Handle Graphics object open in MATLAB workspace
`Figure Loop`	Apply child components to specified graphics figures
`Axes Loop`	Run child components for all axes objects in MATLAB workspace

Examples and How To

Working with the Report Explorer

Overview of the Report Explorer, the MATLAB Report Generator™ and Simulink^® Report Generator graphical interface.

Maintain Interactive MATLAB Report

Describes MATLAB Report Generator interactive Report Generator software tasks previously used for creating a report .

Insert Components

In the Report Explorer, in the Outline pane, select the parent node of the component to be inserted.

Set Component Properties

Most components have properties that you can set to select optional features.

Move Components

In the Report Explorer, in the Outline pane, select the component that you want to move.

Delete Components

In the Report Explorer, in the Outline pane, select the component that you want to delete.

Deactivate Components

You can deactivate any component in a report setup.

Send Components to the MATLAB Workspace

You can send the components of a setup from the Report Explorer to the MATLAB workspace.

Edit Figure Loop Components

This example uses the Figure Loop, which is representative of many types of loops.

Define Report Variables

Use MATLAB variables for components.

Style Sheet Cells for Headers and Footers

Use style sheet cells to manage headers and footers in reports.

Concepts

Components

Explains what components are and how to use them.

Report Structure Components

Use report structure components to organize the content of your report into chapters, sections, paragraphs, lists, tables, and other standard document structure elements.

Table Formatting Components

Use table formatting components to organize generated content into tables.

Property Table Components

Use Property Table components to display property name/property value pairs in tables in generated reports.

Summary Table Components

Use Summary Table components to display information about specified objects in tables in generated reports.

Logical and Looping Components

Example of how to use the Figure Loop component to loop on Handle Graphics^® figures

Set Component Properties

Most components have properties that you can set to select optional features.