mlreportgen.dom.Heading 类
命名空间: mlreportgen.dom
超类: mlreportgen.dom.Paragraph
使用变量级别的标题段落
描述
创建特定级别或在报告生成期间计算其级别的标题段落。
提示
如果您需要在运行时确定标题级别,请使用此类。否则,您可以使用 Heading1
、Heading2
等类来避免必须明确设置级别。
mlreportgen.dom.Heading
类是一个 handle
类。
创建对象
描述
输入参量
标题级别,指定为数值或变量。使用变量来使用报告生成期间计算的值来确定级别编号。
数据类型: double
用于标题的文本,指定为字符向量或字符串标量。
数据类型: char
| string
styleName
指定的样式必须指定用于创建追加此标题的文档的模板中定义的段落样式。
数据类型: char
| string
标题中包含的 DOM 对象,指定为以下任意 DOM 对象类型:
ExternalLink
Image
InternalLink
LinkTarget
Text
属性
包含 CSS 颜色名称或十六进制 RGB 值的背景颜色,指定为字符向量或字符串标量。
要使用颜色名称,请指定一个 CSS 颜色名称。要查看 CSS 颜色名称列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#
作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"
指定蓝色。
注意
设置 BackgroundColor
属性会将 mlreportgen.dom.BackgroundColor
格式的对象添加到 Style
属性。将 BackgroundColor
属性设置为空值将删除该对象。
示例: "blue"
示例: "#0000ff"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
选择对此文档元素使用粗体,指定为数值或逻辑值 1
(true
) 或 0
(false
)。要使文档元素变为粗体,请将 Bold
设置为 true
或 1
。
注意
设置 Bold
属性会将相应的 mlreportgen.dom.Bold
格式对象添加到 Style
属性。将 Bold
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: logical
文档元素对象颜色,指定为包含 CSS 颜色名称或十六进制 RGB 值的字符向量或字符串标量。
要使用颜色名称,请指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#
作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"
指定蓝色。
注意
设置 Color
属性会将相应的 mlreportgen.dom.Color
格式对象添加到 Style
属性。将 Color
属性设置为空值将删除该对象。
示例: "blue"
示例: "#0000ff"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
文档元素的自定义属性,指定为 mlreportgen.dom.CustomAttribute
对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
本段第一行的缩进量,由数字和计量单位的缩写组成,指定为字符向量或字符串标量。例如,“0.5in”表示半英寸。有效的缩写是:
"px"
- 像素"cm"
- 厘米"in"
- 英寸"mm"
- 毫米"pc"
- 派卡"pt"
- 磅
缩进量是本段落第一行相对于后续行的缩进量。要创建悬挂缩进(即除第一行之外的所有行都缩进),请使用负数。
注意
设置 FirstLineIndent
属性会将相应的 mlreportgen.dom.FirstLineIndent
格式对象添加到此文档元素的 Style
属性。将 FirstLineIndent
属性设置为空值将删除该对象。
示例: "0.5in"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
用于文本的字体系列的名称,指定为字符向量或字符串标量。要指定字体的替代,请不要通过设置此属性来指定字体系列。相反,创建一个 mlreportgen.dom.FontFamily
对象并将其添加到 Style
属性。
注意
设置 FontFamilyName
属性会将相应的 mlreportgen.dom.FontFamily
格式对象添加到 Style
属性。设置 FontFamilyName
属性与设置 FontName
对象的 mlreportgen.dom.FontFamily
属性相同。将 FontFamilyName
属性设置为空值将删除该对象。
示例: "Courier New"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
用于包含数字后跟计量单位缩写符的文档元素的字体大小,指定为字符向量或字符串标量。例如,"12pt"
指定十二磅。有效的缩写是:
"px"
- 像素"cm"
- 厘米"in"
- 英寸"mm"
- 毫米"pc"
- 派卡"pt"
- 磅
注意
设置 FontSize
属性会将相应的 mlreportgen.dom.FontSize
格式对象添加到 Style
属性。将 FontSize
属性设置为空值将删除该对象。
示例: "12pt"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
此段落相对于页边距或表单元格边框的水平对齐方式,指定为此表中的一个值。
值 | 描述 | 支持的输出类型 |
---|---|---|
| 将段落居中。 | 全部 |
| 平等分配所有字符。 | Word |
| 将段落左侧与页面或表条目的左侧对齐,将段落右侧与页面或表条目的右侧对齐。 | 全部 |
| 使用最宽的 Kashida 长度。 Kashida 是用于某些草书(例如阿拉伯语和波斯语)的一种对齐方式。 | Word |
| 使用最短的 Kashida 长度。 | Word |
| 使用中等 Kashida 长度。 | Word |
| 段落左对齐。 | 全部 |
| 右对齐段落。 | 全部 |
| 泰语解释。 | Word |
注意
设置 HAlign
属性会将相应的 mlreportgen.dom.HAlign
格式对象添加到此文档元素的 Style
属性。将 HAlign
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
选择对文档元素使用斜体,指定为数值或逻辑值 1
(true
) 或 0
(false
)。要使文档元素变为斜体,请将 Italic
设置为 true
或 1
。
注意
设置 Italic
属性会将相应的 mlreportgen.dom.Italic
格式对象添加到 Style
属性。将 Italic
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: logical
此段落中包含数字后跟单位缩写,以字符向量或字符串标量指定,左缩进。例如,“0.5in”表示半英寸。有效的缩写是:
"px"
- 像素"cm"
- 厘米"in"
- 英寸"mm"
- 毫米"pc"
- 派卡"pt"
- 磅
左缩进是本段落左外边界与其容器左内边界之间的空间。这相当于 Microsoft® Word 段落的左缩进属性。
注意
设置 OuterLeftMargin
属性会将相应的 mlreportGen.dom.OuterMargin
格式对象添加到此文档元素的 Style
属性。将 OuterLeftMargin
属性设置为空值将删除该对象。
提示
要从页面的左边距和右边距缩进段落,请不要设置此属性。相反,创建一个指定左右缩进的 mlreportgen.dom.OuterMargin
,并将该对象添加到此段落的 Style
属性。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
段落的大纲级别,指定为整数。设置 OutlineLevel
属性会导致该段落包含在自动生成的大纲中,例如目录。该值指定了大纲中段落的级别。例如,若要使段落出现在大纲的顶层,请将 OutlineLevel
属性设置为 1
。
注意
设置 OutlineLevel
属性会将相应的 mlreportgen.dom.OutlineLevel
格式对象添加到 Style
属性。将 OutlineLevel
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: int32
文本删除线,指定为以下值之一:
"none"
- 无删除线"single"
- 单行"double"
- 双线(仅适用于 Word 报告)
注意
设置 Strike
属性会将相应的 mlreportgen.dom.Strike
格式对象添加到此文档元素的 Style
属性。将 Strike
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
指定文本格式的 mlreportgen.dom.DOCXSection
对象数组。
样式表中定义的样式名称,指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观,除非该元素的 Style
属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息,请参阅 使用样式表样式。
注意
Microsoft Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息,请参阅DOM API 报告程序模板。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
下划线的类型,指定为此表中的值之一。
下划线值 | 描述 | 支持的输出类型 |
---|---|---|
| 单线 | 全部 |
| 所有字符都加下划线(空格除外) | Word |
| 双线 | Word |
| 粗线 | Word |
| 点线 | Word |
| 粗点线 | Word |
| 虚线 | Word |
| 粗虚线 | Word |
| 长虚线 | Word |
| 粗长虚线 | Word |
| 点划线 | Word |
| 粗点划线 | Word |
| 双点划线 | Word |
| 粗划线,划线之间有两个点 | Word |
| 波浪线 | Word |
| 粗波浪线 | Word |
| 双波浪线 | Word |
| 无下划线 | 全部 |
要指定下划线的颜色和类型,请不要设置 Underline
属性。相反,设置 Style
属性以包含指定下划线类型和颜色的 mlreportgen.dom.Underline
格式对象。
注意
设置 Underline
属性会将相应的 mlreportgen.dom.Underline
格式对象添加到 Style
属性。将 Underline
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
如何处理文本中的空白和换行符,指定为此表中的一个值。当 WhiteSpace
对象的 Type
属性为 PDF 时,Document
属性不适用。
值 | 描述 | 支持的输出类型 |
---|---|---|
| 对于 HTML 和 PDF,此值会删除文本开头和结尾的空白。文本中的多个空白折叠为一个空白。 对于 Microsoft Word,此值将删除文本开头和结尾的空白。 | 全部 |
| 一系列的空白合并为一个单独的空白。文本永远不会换到下一行。 | HTML |
| 保留空白。文本仅在换行处换行。作用类似于 HTML 中的 | HTML 和 PDF |
| 与 "pre" 相同。 | 全部 |
| 一系列的空白合并为一个单独的空白。文本在必要时换行和换行。 | HTML 和 PDF |
| 保留空白。文本在必要时换行和换行。 | HTML 和 PDF |
注意
设置 WhiteSpace
属性会将相应的 mlreportgen.dom.WhiteSpace
格式对象添加到 Style
属性。将 WhiteSpace
属性设置为空值将删除该对象。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
标记,指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID
,其中 CLASS
是对象类,ID
是对象的 Id
属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
目标标识符,指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char
| string
方法
版本历史记录
在 R2014b 中推出
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
选择网站
选择网站以获取翻译的可用内容,以及查看当地活动和优惠。根据您的位置,我们建议您选择:。
您也可以从以下列表中选择网站:
如何获得最佳网站性能
选择中国网站(中文或英文)以获得最佳网站性能。其他 MathWorks 国家/地区网站并未针对您所在位置的访问进行优化。
美洲
- América Latina (Español)
- Canada (English)
- United States (English)
欧洲
- 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)