mlreportgen.dom.Heading class
Package: mlreportgen.dom
Superclasses: mlreportgen.dom.Paragraph
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.
The mlreportgen.dom.Heading
class is a handle
class.
Creation
Description
creates an empty heading at the specified level.headingObj
= Heading(level
)
Input Arguments
level
— Heading level
numeric value | variable
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
— Heading text
character vector
Text to use for the heading, specified as a character vector.
styleName
— Style for text
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.
domObj
— DOM object to include in heading
mlreportgen.dom.ExternalLink
object | mlreportgen.dom.Image
object | mlreportgen.dom.InternalLink
object | mlreportgen.dom.LinkTarget
object | mlreportgen.dom.Text
object
DOM object to include in the heading, specified as any of these DOM object types:
ExternalLink
Image
InternalLink
LinkTarget
Text
Properties
BackgroundColor
— Background color
[]
(default) | character vector | string scalar
Background color, specified as a character vector or string scalar that
consists of a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a
hexadecimal RGB (truecolor) value in the form
#RRGGBB
.
Setting the BackgroundColor
property adds a corresponding
mlreportgen.dom.BackgroundColor
format object to the
Style
property. Setting the
BackgroundColor
property to an empty value
removes the object.
Example: 'blue'
Example: '#0000ff'
Bold
— Whether to use bold for text
[]
(default) | true
or 1
| false
or 0
Whether to use bold for text, specified as a numeric or logical 1
(true
) or 0
(false
). To
make text bold, set Bold
to true
or
1
.
Setting the Bold
property adds a corresponding
mlreportgen.dom.Bold
format object to the Style
property. Setting the Bold
property to an empty value removes the
object.
Color
— Text color
[]
(default) | character vector | string scalar
Text color, specified as a character vector or string scalar that consists of
a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a
hexadecimal RGB (truecolor) value in the form
#RRGGBB
.
Setting the Color
property adds a corresponding
mlreportgen.dom.Color
format object to the
Style
property. Setting the
Color
property to an empty value removes the
object.
Example: 'blue'
Example: '#0000ff'
CustomAttributes
— Custom attributes of document element
array of mlreportgen.dom.CustomAttribute
objects
Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute
objects. The custom attributes must be
supported by the output format.
FirstLineIndent
— Indentation amount for first line of paragraph
[]
| character vector | string scalar
Indentation amount for the fist line of this paragraph, specified as a character vector or string scalar that consists of number followed by an abbreviation for a unit of measurement. For example, '0.5in' specifies one-half inch. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
The indentation amount is the amount by which to indent the first line of this paragraph relative to the succeeding lines. To create a hanging indent where all of the lines are indented except for the first line, use a negative number.
Setting the FirstLineIndent
property adds a corresponding
mlreportgen.dom.FirstLineIndent
format object to the
Style
property for this document element. Setting the
FirstLineIndent
property to an empty value removes the
object.
Example: '0.5in'
FontFamilyName
— Name of font family for text
[]
| character vector | string scalar
Name of a font family to use for text, specified as a character vector or string scalar.
Setting the FontFamilyName
property adds a corresponding
mlreportgen.dom.FontFamily
format object to the
Style
property. Setting the FontFamilyName
property is the same as setting the FontName
property of an
mlreportgen.dom.FontFamily
object. Setting the
FontFamilyName
property to an empty value removes the
object.
To specify substitutions for the font, do not specify the font family by setting this
property. Instead create and add an mlreportgen.dom.FontFamily
object
to the Style
property.
Example: 'Courier New'
FontSize
— Font size for text
character vector
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
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— pointspx
— pixels
HAlign
— Horizontal alignment of paragraph
'center'
| 'distribute'
| ...
Horizontal alignment for this paragraph, relative to page margins or table cell borders, specified as one of the values in this table.
Value | Description | Supported Output Types |
---|---|---|
| Center the paragraph. | All |
| Distribute all characters equally. | Word |
| Align left side of paragraph on left side of page or table entry, and right side of paragraph on the right side of the page or table entry. | All |
| Use widest Kashida length. Kashida is a type of justification used for some cursive scripts, such as Arabic and Persian. | Word |
| Use lowest Kashida length. | Word |
| Use medium Kashida length. | Word |
| Align paragraph left. | All |
| Align paragraph right. | All |
| Thai language justification. | Word |
Setting the HAlign
property adds a corresponding
mlreportgen.dom.HAlign
format object to the
Style
property for this document element. Setting the
HAlign
property to an empty value removes the object.
Id
— ID for this document element
character vector | string scalar
ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
Italic
— Whether to use italic for text
[]
(default) | true
or 1
| false
or 0
Whether to use italic for text, specified as a numeric or logical 1
(true
) or 0
(false
). To
make text italic, set Italic
to true
or
1
.
Setting the Italic
property adds a corresponding
mlreportgen.dom.Italic
format object to the Style
property. Setting the Italic
property to an empty value removes the
object.
OuterLeftMargin
— Left margin (indentation) of document element
character vector
Left indentation in the form valueUnits
. Units
is
an abbreviation for the units. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
OutlineLevel
— Outline level of paragraph
[]
(default) | integer
Outline level of the paragraph, specified as an integer. 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 outline. For example, to make a paragraph appear at the
top level in an outline, set the OutlineLevel
property to
1
.
Setting the OutlineLevel
property adds a corresponding
mlreportgen.dom.OutlineLevel
format object to the
Style
property. Setting the OutlineLevel
property to an empty value removes the object.
Strike
— Text strikethrough
[] (default) | 'none'
| 'single'
| 'double'
Text strikethrough, specified as one of these values:
'none'
— No strikethrough'single'
— Single line'double'
— Double line (for Word reports only)
Setting the Strike
property adds a corresponding
mlreportgen.dom.Strike
format object to the
Style
property for this document element. Setting the
Strike
property to an empty value removes the object.
Style
— Text formatting
array of mlreportgen.dom.DOCXSection
objects
An array of mlreportgen.dom.DOCXSection
objects that
specifies the format for the text.
StyleName
— Name of style to apply to text
character vector
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
— Tag for this document element
character vector | string scalar
Tag for this document element, specified as a character vector or string scalar.
The DOM generates a session-unique tag as part of the creation of this object. The
generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value
of the Id
property of the object. Specifying your own tag value can
help you to identify where an issue occurred during document generation.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
Underline
— Type of underline
[]
(default) | 'single'
| 'none'
| ...
Type of underline, specified as one of the values in this table.
Underline value | Description | Supported Output Types |
---|---|---|
| Single line | All |
| Underline all characters except spaces | Word |
| Double line | Word |
| Thick line | Word |
| Dotted line | Word |
| Thick dotted line | Word |
| Dashed line | Word |
| Line with heavy dashes | Word |
| Line with long dashes | Word |
| Line with heavy long dashes | Word |
| Dot-dash line | Word |
| Heavy dash-dot line | Word |
| Dot-dot-dash line | Word |
| Line with heavy dashes with two dots between the dashes | Word |
| Wavy line | Word |
| Heavy wavy | Word |
| Double wavy line | Word |
| No underline | All |
Setting the Underline
property adds a corresponding
mlreportgen.dom.Underline
format object to the
Style
property. Setting the Underline
property
to an empty value removes the object.
To specify both the color and the type of the underline, do not set the
Underline
property. Instead, set the Style
property to include an mlreportgen.dom.Underline
format object that
specifies the underline type and color.
WhiteSpace
— How to treat white space in text
[]
(default) | 'normal'
| 'nowrap'
| ...
How to treat white space in text, specified as one of the values in this table.
Value | Description | Supported Output Types |
---|---|---|
| For HTML and PDF, this value removes spaces at the beginning and the end of text. Multiple spaces in the text collapse to a single space. For Word, this value removes spaces at the beginning and end of text. | All |
| Sequences of white space collapse into a single white space. Text never wraps to the next line. | HTML |
| Preserves white space. Text wraps only on line breaks. Acts
like the | HTML and PDF |
| Sequences of white space collapse into a single white space. Text wraps when necessary and on line breaks. | HTML and PDF |
| Preserves white space. Text wraps when necessary and on line breaks. | HTML and PDF |
| Same as 'pre'. | All |
Setting the WhiteSpace
property adds a corresponding
mlreportgen.dom.WhiteSpace
format object to the
Style
property. Setting the WhiteSpace
property to an empty value removes the object.
Methods
Version History
Introduced in R2014b
MATLAB 命令
您点击的链接对应于以下 MATLAB 命令:
请在 MATLAB 命令行窗口中直接输入以执行命令。Web 浏览器不支持 MATLAB 命令。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)