Learn more about MATLAB Report Generator

Component Reference

Alphabetical List

---

Formatting Components Insert documentation elements Handle Graphics Components Report on Handle Graphics figures Logical and Flow Components Specify conditions that must be met for child components to execute MATLAB Components Interact with MATLAB workspace MATLAB Report Generator Components General-purpose components

Back to Top

Formatting Components

Use Formatting components to insert documentation elements into your report. Formatting components must have the following parent/child relationships.

The following table describes the Formatting components.

Chapter/Subsection	Group portions of report into sections with titles
Empty Component	Group components so that you can easily move, activate, or deactivate them, or create a blank space in a list
Image	Insert image from external file into report
Link	Insert linking anchors or pointers into report
List	Create bulleted or numbered list from cell array or child components
Paragraph	Insert paragraph text into report
Table	Convert rectangular cell array into table and insert it into report
Text	Format and insert text into report
Title Page	Insert title page at beginning of report

Back to Top

Handle Graphics Components

Handle Graphics components report on Handle Graphics figures. The following figure shows the Handle Graphics component hierarchy.

The following table describes the Handle Graphics components.

Axes Loop	Run child components for all axes objects in the MATLAB workspace
Axes Snapshot	Insert image of selected MATLAB axes objects into the generated report
Figure Loop	Apply child components to specified graphics figures
Figure Snapshot	Insert snapshot of Handle Graphics figure into report
Graphics Object Loop	Run child components for each Handle Graphics object that is currently open in the MATLAB workspace
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
Handle Graphics Property Table	Insert table that reports on property name/property value pairs
Handle Graphics Summary Table	Insert table that summarizes Handle Graphics object properties

Back to Top

Logical and Flow Components

Logical and Flow Control components execute conditionally, enabling you to decide when a child component executes or how many times a child component executes.

These components have the following parent/child relationships.

For Loop	Iteratively executes child components
Logical Else	Specify an else condition for a Logical If component
Logical Elseif	Specify an elseif condition for the Logical If component
Logical If	Specify logical if condition
Logical Then	Specify a then condition for the Logical If component
While Loop	Iteratively execute child components while a specified condition is true

Back to Top

MATLAB Components

Use MATLAB components to interact with the MATLAB workspace.

Evaluate MATLAB Expression	Evaluate specified MATLAB expression
Insert Variable	Insert variable values into report
MATLAB Property Table	Insert table that includes MATLAB object property name/property value pairs
MATLAB/Toolbox Version Number	Insert table that shows version and release numbers and release date of MathWorks products
Variable Table	Insert table that displays all the variables in the MATLAB workspace

Back to Top

MATLAB Report Generator Components

This category includes "general utility" components.

Comment	Insert comment into XML source file created by the report-generation process
Import File	Import ASCII text file into report
Nest Setup File	Allow one report template (.rpt file) to run inside another
Stop Report Generation	Halt report generation
Time/Date Stamp	Insert time and date of report generation into report

How The Matching Algorithm Works

Components — Alphabetical List

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS