Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.Heading class

Package: mlreportgen.dom
Superclasses:

Heading paragraph using variable level

Description

Create a heading paragraph at a particular level or whose level is calculated during report generation.

Tip

Use this class if you need to determine the heading level at runtime. Otherwise, you can use the Heading1, Heading2, etc. classes to avoid having to set the level explicitly.

Construction

headingObj = Heading(level) creates an empty heading at the specified level.

headingObj = Heading(level,text) creates the specified level heading containing the specified text.

headingObj = Heading(level,text,styleName) creates the specified level heading containing the specified text and using the specified style.

headingObj = Heading(level,domObj) creates the specified level heading containing the specified DOM object.

Input Arguments

expand all

Heading level, specified as a numeric value or variable. Use a variable to use a value calculated during report generation to determine the level number.

Data Types: double

Text to use for the heading, specified as a character vector.

The style specified by styleName must specify a paragraph style defined in the template used to create the document to which this heading is appended.

DOM object to include in the heading, specified as any of these DOM object types:

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

Output Arguments

expand all

Heading paragraph, represented by an mlreportgen.dom.Heading object.

Properties

expand all

Background color, specified as either:

To make text bold, set this property to true or 1. If this property is empty and the StyleName property for this document element specifies a style sheet style, the weight of the text is determined by that style. Setting the Bold property adds a corresponding mlreportgen.dom.Bold format object to the Style property of this document element. Removing the Bold property setting removes the object.

Data Types: logical

Text color, specified as either:

The output format must support the custom attributes of this document element.

Amount by which to indent the first line of this paragraph relative to succeeding lines. To create a hanging indent, in which all the lines are indented except for the first line, use a negative number.

Specify the value in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations for the units.

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

The name of a font family.

To specify substitutions for this font, do not set this property. Instead create and add a mlreportgen.dom.FontFamily object to the Style property of this document element.

Setting the FontFamilyName property adds a corresponding mlreportGen.dom.FontFamily format object to the Style property for this document element. Setting the FontFamilyName property is the same as setting the FontName property of mlreportgen.dom.FontFamily. Removing the FontFamilyName property setting removes the object.

Font size for text, in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations for the units.

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

  • px — pixels

Horizontal alignment for a paragraph, relative to page margins or table cell borders, specified as one of these values.

ValueDescriptionSupported Output Types

'center'

Center the paragraph

All output types

'distribute'

Distribute all characters equally

Word

'justify'

Align left side of paragraph on left side of page, and right side of paragraph on the right side of the page

All output types

'KashidaHigh'

Use widest Kashida length

Word

'KashidaLow'

Use lowest Kashida length

Word

'KashidaMedium'

Use medium Kashida length

Word

'left'

Align paragraph left

All output types

'right'

Align paragraph right

All output types

'ThaiDistribute'

Thai language justification

Word

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

To use italics for text, set this property to true. If this property is empty and the StyleName property for this document element specifies a style sheet style, the slant of the text is determined by that style. Setting the Italic property adds a corresponding mlreportgen.dom.Italic format object to the Style property of this document element. Removing the Italic property setting removes the object.

Data Types: logical

Left indentation in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Setting the OutlineLevel property causes this paragraph to be included in automatically generated outlines, such as a table of contents. The value specifies the level of the paragraph in the table of contents. For example, to make a paragraph appear as a Heading 1 (Word) or h1 (HTML), set OutlineLevel to 1.

Data Types: int32

Text strikethrough, specified as one of these values:

  • 'none' — Do not use strikethrough.

  • 'single' — Use a single line for strikethrough.

  • 'double' — Use a double line for strikethrough for Word documents.

Setting the Strike property adds a corresponding mlreportGen.dom.Strike format object to the Style property for this document element. Removing the Strike property setting removes the object.

An array of mlreportgen.dom.DOCXSection objects that specifies the format for the text.

The style specified by styleName must be defined in the template used to create the document element to which this text is appended.

Data Types: char

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

You can specify one of the following types of underlines.

Border ValueDescriptionSupported Output Types

'dash'

Dashed underline

Word

'dashedHeavy'

Line with heavy dashes

Word

'dashLong'

Line with long dashes

Word

'dashLongHeavy'

Line with heavy long dashes

Word

'dashDotDotHeavy'

Line with heavy dashes with two dots between the dashes

Word

'dashDotHeavy'

Heavy dash-dot line

Word

'dotted'

Dotted line

Word

'dottedHeavy'

Thick dotted line

Word

'dotDash'

Dot-dash line

Word

'dotDotDash'

Dot-dot-dash line

Word

'dashDotHeavy'

Heavy dot-dash line

Word

'double'

Double line

Word

'none'

Do not use underlining

All output types

'single'

Single line

All output types

'thick'

Thick line

Word

'wave'

Wavy line

Word

'waveyDouble'

Double wavy line

Word

'waveyHeavy'

Heavy wavy

Word

'words'

Underline non-space characters only

Word

If this property is empty and StyleName property of this document element specifies a style sheet style, the type of underline is determined by that style.

To specify the color as well as the type of the underline, do not set the Underline property. Instead, set the Style property of this document element to include an mlreportgen.dom.Underline format object that specifies the desired underline type and color.

Setting the Underline property adds a corresponding mlreportgen.dom.Underline format object to the Style property for this document element. Removing the Underline property setting removes the object.

To specify how to handle white space, use one of these values.

ValueDescriptionSupported Output Types

'normal' (default)

For HTML and PDF, removes spaces at beginning and end of text. Multiple spaces within the text collapse to single space.

For Word, removes spaces at beginning and end of text.

All output types

'nowrap'

Sequences of white space collapse into a single white space. Text never wraps to the next line.

HTML

'preserve'

Preserves spaces and line feeds. Acts like the <pre> tag in HTML.

All output types

'pre'

Preserves white space. Text wraps only on line breaks. Acts like the <pre> tag in HTML.

HTML and PDF

'pre-line'

Sequences of white space collapse into a single white space. Text wraps.

HTML and PDF

'pre-wrap'

Preserves white space. Text wraps when necessary and on line breaks

HTML and PDF

Setting the WhiteSpace property adds a corresponding WhiteSpace format object to Style property. Removing the WhiteSpace property setting removes the WhiteSpace object.

Methods

Method

Purpose

append

Use Heading.append similar to how you use Paragraph.append.

Append content to heading.

clone

Use Heading.clone similar to how you use Paragraph.clone.

Copy heading.

Was this topic helpful?