Text

Format and insert text into report

Description

This component formats and inserts text into the report. It must have the Paragraph component as its parent.

Properties

  • Text to include in report: Specifies text to include in the report.

  • Style Name: Specifies the style to use with the text. To specify a style, perform these steps.

    1. In the Report Options dialog box, set File format to one of these values:

      • Word (from template)

      • HTML (from template)

      • PDF (from template)

    2. Set Style Name to Specify.

    3. In the Style Name text box, type a style name.

      To take effect, the style you specify must be a paragraph (or a linked paragraph/character style for Word reports) defined in the template that you use to generate the report. For more information about template styles, see Create Custom Microsoft Word Report Templates and Create Custom HTML Report Templates.

%<VariableName> Notation

You can enter %<VariableName> in this field (and in any field where the text appears blue) to include the value of a variable from the base MATLAB® workspace. You cannot enter more than one variable in %<>. If you enter an invalid variable name, the report includes the text %<VariableName> instead of the value of the variable.

Example

  1. Enter the following text:

    I have a %<ObjName> and it has %<NumLeaves> leaves. 
    The word '%<ObjName>' has %<size(ObjName)> letters.
    
  2. Set ObjName = "plant" and NumLeaves = 3.

  3. Generate the report. It looks as follows:

    I have a plant and it has 3 leaves.
    The word 'plant' has 5 letters.
    

Style

    Note:   If you use the Style Name field to specify a style for this text component, the style formats below override the corresponding formats specified in the style. For example, selecting Bold makes the text bold, even if the specified style specifies regular weight text.

  • Bold: Makes the text bold.

  • Italic: Makes the text italic.

  • Underline: Underlines the text.

  • Strikethrough: Strikes through the text.

  • Subscript: Formats text as a subscript, in a smaller font than the other text, set slightly below the other text.

  • Superscript: Formats text as a superscript, in a smaller font than the other text, set slightly above the other text.

  • Retain spaces and carriage returns: Formats the text in the report as you entered it.

  • Show text as syntax-highlighted MATLAB code: Shows the text as syntax-highlighted MATLAB code.

  • Color: Specifies the color of the text.

    • Select a color from a list of colors.

    • Enter %<expr>.

    • Enter an RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

Insert Anything into Report?

Yes. Text.

Class

rptgen.cfr_text

Was this topic helpful?