MATLAB Report Generator

List

List

Category

Formatting

Description

The List component creates a bulleted or numbered list from a cell array or from subcomponents.

Attributes

This is the List 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.

Create list from cell array with workspace variable name

Enter the name of the 1-by-n or n-by-1 cell array from which the list will be created in this field. This option is not available when this component has subcomponents, since the list is then automatically generated from the subcomponents.

Formatting Options

    List title

Enter the title of the list in this field.

Spacing

Select either Compact spacing or Normal spacing.

List style

Select either Bulleted list or Numbered list. If you choose Numbered list, then you can select numbering options in the Numeration Options section.

Numeration Options

Numbering Style

Select a numbering style in this pull-down menu if you selected Numbered List for the List style. The options are:

1,2,3,4,...

a,b,c,d,...

A,B,C,D,...

i,ii,iii,iv,...

I,II,III,IV,...

Show parent number in nested list (1.1.a)

Select this option to show all level numbers in a nested list. You can create a nested list by putting one cell array inside another or by nesting one List component inside another. If you choose this option, your list will have this type of appearance (the actual appearance depends on the numbering style chosen in Numeration Options).

• 1. Example
  2. Example
      2.1. Example
      2.2. Example
          2.2.a. Example
          2.2.b. Example
  3. Example
  

Note that this option is not available if you select the Show only current list value (a) option.

Show only current list value (a)

Select this option to show only the current list value. If you choose this option, the list shown above will have this type of appearance (the actual appearance depends on the numbering style chosen in Numeration Options).

• 1. Example
  2. Example
      1. Example
      2. Example
          1. Example
          2. Example
  3. Example
  

Note that this option is not available if you select the Show parent number in nested list (1.1.a) option.

Continue numbering from previous list

Select this option to continue list numbering from a previous list. Note that this option is not available if you select the Always start at 1 option.

Always start at 1

Select this option to always start list numbering at 1. Note that this option is not available if you select the Continue numbering from previous list option.

Example1: Creating a Nested List

You can create a nested list by putting one cell array inside another or by nesting one List component inside another.

For example, if you have the following setup file, with one List component nested inside another List component.

• [-] Report - Unnamed.rpt
     [-] Bulleted list from subcomponents
        [ ] Text - sky
        [ ] Table - varname
        [ ] Image - test.jpg
        [ ] Text - grass
        [-] Bulleted list from subcomponents
           [ ] Text - clouds
           [ ] Text - sun
        [-] Paragraph - information
  

Then the report would contain the following bulleted lists:

• sky
• Table from variable - varname
• Snapshot of image - test.jpg
• grass

  clouds

  sun

• information

Example 2: Creating the Same List With Subcomponents and a Cell Array

Setup file with subcomponents:

•    [-] Report - Unnamed.rpt
        [-] Bulleted list from subcomponents
           [ ] Text - red
           [ ] Text - green
           [ ] Text - blue
  

Setup file calling a cell array:

• [-] Report - Unnamed.rpt
     [-] Bulleted list from cell array called colors
  

Cell array:

• colors={'red','green','blue'}
  

Using either of these two setup files, the report contains the following bulleted list:

• red
• green
• blue

Insert anything into report?

Yes. List.

Filename

cfrlist

Link

Paragraph