MATLAB Report Generator

Stop Report Generation

Stop Report Generation

Category

Report Generator

Description

The Stop Report Generation component halts report generation. This component acts like the Stop button during report generation.

You can use this component inside an If...then statement by using Logical and Flow Control components to halt the report generation process under a certain condition. Note that when report generation is halted, the SGML source file is produced, but not converted.

Attributes

This is the Stop Report Generation component attribute page.

Note    To view a component attribute page in the Setup File Editor, select the component in the setup file outline on the left and click on the Options tab. If the component is not in the setup file outline, you must add it to the outline first. See Building and Editing the Setup File for a discussion on how to add a component to the outline.

Options

If you want the Report Generator to prompt you before it halts report generation, select the Confirm before stopping generation. If you select this option, the Report Generator opens a dialog box similar to the one shown below.

You can write the question that will appear in the dialog box in the Confirmation question field.

Example

The setup file in this example creates a simple report that takes the snapshot of the current figure. If there is no current figure, the report generation automatically halts.

• [-] Report - figure-report.rpt
      [-] if (isempty(get(0,'CurrentFigure')))
          [ ] Stop Generation
      [-] Figure Loop - current
          [-] Chapter - <Title from SubComponent1>
              [ ] Figure Name
              [ ] Graphics Figure Snapshot
              [ ] Figure Prop Table - Figure Properties
  

Insert anything into report?

No

Filename

crg_halt_gen

Nest Setup File

Time/Date Stamp