Learn more about MATLAB Report Generator

Working with Property Table Components

On this page…

About Property Table Components Opening the Example Report Template Examining the Property Table Output Selecting Object Types Displaying Property Name/Property Value Pairs Editing Table Titles Entering Text into Table Cells Adding, Replacing, and Deleting Properties in Tables Displaying or Hiding Cell Borders Adding and Deleting Columns and Rows Resizing Columns Zooming and Scrolling Selecting Tables

About Property Table Components

Property Table components display property name/property value pairs for objects in tables. This appears in the following example table from the figloop-tutorial report.

Many types of Property Table components are available, including:

• MATLAB Property Table

• Simulink Property Table

• Stateflow Property Table

The component used in this example represents MATLAB Report Generator Property Table components, all of which exhibit similar behavior.

Back to Top

Opening the Example Report Template

This example uses the figloop-tutorial report template. To open the figure loop tutorial report template, enter the following at the MATLAB command line:

setedit figloop-tutorial

Back to Top

Examining the Property Table Output

Property pages for all Property Table components are similar in form. The following figure shows the Properties pane for the Handle Graphics Property Table component. To modify table settings, click Edit.

Back to Top

Selecting Object Types

Property Table components offer multiple object types on which to report. For example, the Handle Graphics Property table lets you report on a figure, an axes object, or a Handle Graphics object.

You can select a different object type on which to report in the Object type list in the component's Properties pane.

Back to Top

Displaying Property Name/Property Value Pairs

Split Property/Value Cells

In the Handle Graphics Property Table component's Properties pane, click Edit.

1. For a given property name and property value to appear together in one cell of a table, clear the Split property/value cells check box. The table is now in nonsplit mode. Nonsplit mode supports more than one property name/property value pair per cell and text.

   

2. For the property name and property value to appear in adjacent horizontal cells in the table, select the Split property/value cells check box. The table is now in split mode. Split mode supports only one property name/property value pair per cell. If more than one property pair appears in a cell, only the first pair appears in the report; all subsequent pairs are ignored.

   

Display Options

Property name/property value pairs can appear in cells in several ways. To specify how a given property name/property value pair appears in a cell, select that field in the table and choose Value from the Display As selection list under the Figure Properties box. In the selected table row, only the value appears.

Formatting Options

To specify alignment for text in a given cell, use the four justification buttons in the toolbar under the Figure Properties box.

In this example, the selected table row is double justified. To change justification options, right-click a table row and make the changes in its context menu.

Back to Top

Editing Table Titles

Table titles can contain properties and text. By default, the title of a table is the same as the value of the %<Name> property. You can modify this property to modify the table title.

Note   Table titles are always in nonsplit mode.

Back to Top

Entering Text into Table Cells

To enter text into a table cell, double-click the cell. A gray box appears with the label for the cell property.

If you type text outside the angle brackets, the text appears as is in the report. Text inside the table brackets must specify a valid property name. If you enter an invalid property name, the property name appears in the report without a property value.

Note   For the text to be visible, the table must be in nonsplit mode.

Back to Top

Adding, Replacing, and Deleting Properties in Tables

Adding Table Properties

To add a Handle Graphics property to a table cell:

1. In the Figure Prop Table window, add a new table row to the current table.

   1. Select a table row directly under the row to which to add a new property.

   2. Click Add Row Above Current Cell.

      A new row appears above the current row.

2. Add the property to the new table row.

   1. Select the new table row.

   2. In the Properties Type selection menu at the upper-right of the window, select a property type.

   3. In the Properties menu, select the property you want to add.

   4. Click the << Add button, or double-click the property name. The property appears in the table row.

   Alternatively, if you know the name of the property you want to add, enter the property name directly into the cell as described in Entering Text into Table Cells. For information about adding new table rows, see Adding and Deleting Columns and Rows.

Replacing Table Properties

To replace a property in a cell of a table in split mode, follow the instructions in Adding Table Properties.

Note   You cannot use these steps to delete a property in a cell when the table is in nonsplit mode.

Deleting Table Properties

Delete a property by backspacing over it or using the Delete key.

Back to Top

Displaying or Hiding Cell Borders

To toggle cell borders on and off:

1. Place your cursor in a cell and right-click to invoke its context menu.

2. Choose Cell borders > Top, Bottom, Right, or Left to toggle the specified border on or off.

Back to Top

Adding and Deleting Columns and Rows

To add or delete a column or row, select a cell and then click one of the buttons described in the following table.

Note   You cannot delete a row or column when it is the only row or column in the table.

Button	Action
	Add column (added to the left of the selected column)
	Delete selected column
	Add row (added above the selected row)
	Delete selected row

Back to Top

Resizing Columns

To resize the width of a column, click and drag its vertical borders as needed.

Back to Top

Zooming and Scrolling

Zooming

You can zoom in and out of the table with the zoom buttons, which are located to the left of the horizontal scroll bar.

Button	Action
	Zoom in
	Zoom out

Scrolling

You can scroll vertically and horizontally using the table's scroll bars.

Back to Top

Selecting Tables

To display property name/property value pairs, you can select a preset table or use a custom table.

• A preset table is built-in and formatted. You can select a preset table in the preset table selection list in the upper-left of the Figure Prop Table window. To apply a preset table, select the table and click Apply.

• To create a custom table, select a preset table and modify it to fit your needs by adding and/or deleting rows and properties. You may want to start with the Blank 4x4 preset table.

  Note   You cannot save a custom table as a preset table. If you do so, you lose all changes to the custom table.

Back to Top

Working with Looping Components

Working with Summary Table Components

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