mlreportgen.dom.Heading1 类

命名空间: mlreportgen.dom
超类: mlreportgen.dom.Heading

创建标题 1 段落

全页展开

描述

创建一个 mlreportgen.dom.Heading1 段落对象。

mlreportgen.dom.Heading1 类是一个 handle 类。

创建对象

描述

headingObj = Heading1 创建一个空 Heading1 对象。

示例

headingObj = Heading1(text) 创建包含指定文本的标题。

headingObj = Heading1(text,styleName) 使用指定的样式创建标题。

headingObj = Heading1(domObj) 创建包含指定 DOM 对象的标题。

输入参量

全部展开

`text` — 标题文本
字符向量 | 字符串标量

用于标题的文本，指定为字符向量或字符串标量。

数据类型: char | string

`styleName` — 文本样式
字符向量 | 字符串标量

styleName 指定的样式必须指定用于创建追加此标题的文档的模板中定义的段落样式。

数据类型: char | string

`domObj` — 包含在标题中的 DOM 对象
`mlreportgen.dom.ExternalLink` 对象 | `mlreportgen.dom.Image` 对象 | `mlreportgen.dom.InternalLink` 对象 | `mlreportgen.dom.LinkTarget` 对象 | `mlreportgen.dom.Text` 对象

标题中包含的 DOM 对象，指定为以下任意 DOM 对象类型：

ExternalLink
Image
InternalLink
LinkTarget
Text

属性

全部展开

`BackgroundColor` — 背景色
`[]` (默认) | 字符向量 | 字符串标量

由 CSS 颜色名称或十六进制 RGB 值组成的背景颜色，指定为字符向量或字符串标量。

有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式，请使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色值。例如，"#0000ff" 指定蓝色。

注意

设置 BackgroundColor 属性会将 mlreportgen.dom.BackgroundColor 格式的对象添加到 Style 属性。将 BackgroundColor 属性设置为空值将删除该对象。

示例: "blue"

示例: "#0000ff"

属性：

NonCopyable true

数据类型: char | string

`Bold` — 选择对文档元素使用粗体
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

该文档元素可使用粗体显示，指定为数字或逻辑值 1 (true) 或 0 (false)。要使文档元素变为粗体，请将 Bold 设置为 true 或 1。

注意

设置 Bold 属性会将相应的 mlreportgen.dom.Bold 格式对象添加到 Style 属性。将 Bold 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: logical

`Color` — 文档元素颜色
`[]` (默认) | 字符向量 | 字符串标量

文档元素颜色由 CSS 颜色名称（请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords）或 #RRGGBB 形式的十六进制 RGB（真彩色）值组成，指定为字符向量或字符串标量。

注意

设置 Color 属性会将相应的 mlreportgen.dom.Color 格式对象添加到 Style 属性。将 Color 属性设置为空值将删除该对象。

示例: "blue"

示例: "#0000ff"

属性：

NonCopyable true

数据类型: char | string

`FirstLineIndent` — 段落首行的缩进量
`[]` | 字符向量 | 字符串标量

本段第一行的缩进量，由数字和计量单位的缩写组成，指定为字符向量或字符串标量。例如，“0.5in”表示半英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

缩进量是本段落第一行相对于后续行的缩进量。要创建悬挂缩进（即除第一行之外的所有行都缩进），请使用负数。

注意

设置 FirstLineIndent 属性会将相应的 mlreportgen.dom.FirstLineIndent 格式对象添加到此文档元素的 Style 属性。将 FirstLineIndent 属性设置为空值将删除该对象。

示例: "0.5in"

属性：

NonCopyable true

数据类型: char | string

`FontFamilyName` — 文本的字体系列名称
`[]` | 字符向量 | 字符串标量

用于文本的字体系列的名称，指定为字符向量或字符串标量。要指定字体的替代，请不要通过设置此属性来指定字体系列。相反，创建一个 mlreportgen.dom.FontFamily 对象并将其添加到 Style 属性。

注意

设置 FontFamilyName 属性会将相应的 mlreportgen.dom.FontFamily 格式对象添加到 Style 属性。设置 FontFamilyName 属性与设置 mlreportgen.dom.FontFamily 对象的 FontName 属性相同。将 FontFamilyName 属性设置为空值将删除该对象。

示例: "Courier New"

属性：

NonCopyable true

数据类型: char | string

`FontSize` — 文档元素的字体大小
`[]` (默认) | 字符向量 | 字符串标量

用于文档元素的字体大小，由数字和后跟计量单位缩写组成，指定为字符向量或字符串标量。例如，"12pt" 指定十二个点。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

注意

设置 FontSize 属性会将相应的 mlreportgen.dom.FontSize 格式对象添加到 Style 属性。将 FontSize 属性设置为空值将删除该对象。

示例: "12pt"

属性：

NonCopyable true

数据类型: char | string

`HAlign` — 段落水平对齐
`"center"` | `"distribute"` | ... | ...

此段落相对于页边距或表格单元格边框的水平对齐方式，指定为此表中的一个值。

值	描述	支持的输出类型
`"center"`	将段落居中。	全部
`"distribute"`	平等分配所有角色。	Word
`"justify"`	将段落左侧与页面或表条目的左侧对齐，将段落右侧与页面或表条目的右侧对齐。	全部
`"KashidaHigh"`	使用最宽的 Kashida 长度。 Kashida 是用于某些草书（例如阿拉伯语和波斯语）的一种对齐方式。	Word
`"KashidaLow"`	使用最短的 Kashida 长度。	Word
`"KashidaMedium"`	使用中等 Kashida 长度。	Word
`"left"`	段落左对齐。	全部
`"right"`	右对齐段落。	全部
`"ThaiDistribute"`	泰语解释。	Word

注意

设置 HAlign 属性会将相应的 mlreportgen.dom.HAlign 格式对象添加到此文档元素的 Style 属性。将 HAlign 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: char | string

`Italic` — 选择使用斜体作为文档元素
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

选择使用斜体作为文档元素，指定为数字或逻辑 1 (true) 或 0 (false)。要使文档元素变为斜体，请将 Italic 设置为 true 或 1。

注意

设置 Italic 属性会将相应的 mlreportgen.dom.Italic 格式对象添加到 Style 属性。将 Italic 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: logical

`OuterLeftMargin` — 段落左缩进
`[]` | 字符向量 | 字符串标量

本段落的左缩进由一个数字和后跟计量单位的缩写组成，指定为字符向量或字符串标量。例如，“0.5in”表示半英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

左缩进是本段落左外边界与其容器左内边界之间的空间。这相当于 Microsoft^® Word 段落的左缩进属性。

注意

设置 OuterLeftMargin 属性会将相应的 mlreportGen.dom.OuterMargin 格式对象添加到此文档元素的 Style 属性。将 OuterLeftMargin 属性设置为空值将删除该对象。

提示

要从页面的左边距和右边距缩进段落，请不要设置此属性。相反，创建一个指定左右缩进的 mlreportgen.dom.OuterMargin，并将该对象添加到此段落的 Style 属性。

属性：

NonCopyable true

数据类型: char | string

`OutlineLevel` — 段落大纲级别
`[]` (默认) | 整数

段落的大纲级别，指定为整数。设置 OutlineLevel 属性会导致该段落包含在自动生成的大纲中，例如目录。该值指定了大纲中段落的级别。例如，若要使段落出现在大纲的顶层，请将 OutlineLevel 属性设置为 1。

注意

设置 OutlineLevel 属性会将相应的 mlreportgen.dom.OutlineLevel 格式对象添加到 Style 属性。将 OutlineLevel 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: int32

`Strike` — 文本删除线
`[]` (默认) | `"none"` | `"single"` | `"double"`

文本删除线，指定为以下值之一：

"none" - 无删除线
"single" - 单行
"double" - 双线（仅适用于 Word 报告）

注意

设置 Strike 属性会将相应的 mlreportgen.dom.Strike 格式对象添加到此文档元素的 Style 属性。将 Strike 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: char | string

`Underline` — 下划线类型
`[]` (默认) | `"single"` | `"none"` | ...

下划线的类型，指定为此表中的值之一。

下划线值	描述	支持的输出类型
`"single"`	单线	全部
`"words"`	所有字符都加下划线（空格除外）	Word
`"double"`	双线	Word
`"thick"`	粗线	Word
`"dotted"`	点线	Word
`"dottedHeavy"`	粗点线	Word
`"dash"`	虚线	Word
`"dashedHeavy"`	粗虚线	Word
`"dashLong"`	长虚线	Word
`"dashLongHeavy"`	粗长虚线	Word
`"dotDash"`	点划线	Word
`"dashDotHeavy"`	粗点划线	Word
`"dotDotDash"`	双点划线	Word
`"dashDotDotHeavy"`	粗划线，划线之间有两个点	Word
`"wave"`	波浪线	Word
`"wavyHeavy"`	粗波浪线	Word
`"wavyDouble"`	双波浪线	Word
`"none"`	无下划线	全部

要指定下划线的颜色和类型，请不要设置 Underline 属性。相反，设置 Style 属性以包含指定下划线类型和颜色的 mlreportgen.dom.Underline 格式对象。

注意

设置 Underline 属性会将相应的 mlreportgen.dom.Underline 格式对象添加到 Style 属性。将 Underline 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: char | string

`WhiteSpace` — 如何处理文本中的空白
`[]` (默认) | `"normal"` | `"nowrap"` | ...

如何处理文本中的空白和换行符，指定为此表中的一个值。

值	描述	支持的输出类型
`"normal"`	对于 HTML 和 PDF，此值会删除文本开头和结尾的空白。文本中的多个空白折叠为一个空白。对于 Microsoft Word，此值将删除文本开头和结尾的空白。	全部
`"nowrap"`	一系列的空白合并为一个单独的空白。文本永远不会换到下一行。	HTML
`"pre"`	保留空白。文本仅在换行处换行。作用类似于 HTML 中的 `<pre>` 标签。	HTML 和 PDF
`"preserve"`	与 "pre" 相同。	全部
`"pre-line"`	一系列的空白合并为一个单独的空白。文本在必要时换行和换行。	HTML 和 PDF
`"pre-wrap"`	保留空白。文本在必要时换行和换行。	HTML 和 PDF

注意

设置 WhiteSpace 属性会将相应的 mlreportgen.dom.WhiteSpace 格式对象添加到 Style 属性。将 WhiteSpace 属性设置为空值将删除该对象。

数据类型: char | string

`StyleName` — 元素的样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了此元素在输出文档中的外观，除非由此元素的 Style 属性指定的格式覆盖。要了解有关使用样式表的更多信息，请参阅使用样式表样式。

注意

Microsoft Word 输出忽略样式名称。

属性：

NonCopyable true

数据类型: char | string

`Style` — 格式设定
`{}` (默认) | 格式对象数组

此文档元素对象的格式规范，指定为格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此元素的格式将被忽略。

属性：

NonCopyable true

数据类型: cell

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable true

`Parent` — `mlreportgen.dom.Heading1` 对象的父级
文档元素对象

mlreportgen.dom.Heading1 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — `mlreportgen.dom.Heading1` 对象的子级
文档元素对象数组

mlreportgen.dom.Heading1 对象的子项，指定为文档元素对象的数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — `mlreportgen.dom.Heading1` 对象的标签
字符向量 | 字符串标量

mlreportgen.dom.Heading1 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable true

数据类型: char | string

`Id` — `mlreportgen.dom.Heading1` 对象的标识符
字符向量 | 字符串标量

mlreportgen.dom.Heading1 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable true

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append` `Heading1.append` 的使用方式与 `Paragraph.append` 类似。	将内容追加到标题。
`clone` `Heading1.clone` 的使用方式与 `Paragraph.clone` 类似。	复制标题。

方法

用途

append

Heading1.append 的使用方式与 Paragraph.append 类似。

将内容追加到标题。

clone

Heading1.clone 的使用方式与 Paragraph.clone 类似。

复制标题。

示例

全部折叠

创建三级标题

打开脚本

此示例显示如何添加三级标题，每级标题均根据其级别进行格式化。此示例在文档中插入三个标题对象：Heading1、Heading2 和 Heading3。

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);

title = append(d, Paragraph('Document Title'));
title.Bold = true;
title.FontSize = '28pt';

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
p2 = append(d,Paragraph('Text for this section.'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d,Paragraph('Text for this subsection'));

close(d);
rptview(d.OutputPath);

版本历史记录

在 R2016a 中推出

另请参阅

主题

报告格式化方法

mlreportgen.dom.Heading1 类

描述

创建对象

描述

输入参量

text — 标题文本 字符向量 | 字符串标量

styleName — 文本样式 字符向量 | 字符串标量

domObj — 包含在标题中的 DOM 对象 mlreportgen.dom.ExternalLink 对象 | mlreportgen.dom.Image 对象 | mlreportgen.dom.InternalLink 对象 | mlreportgen.dom.LinkTarget 对象 | mlreportgen.dom.Text 对象

属性

BackgroundColor — 背景色 [] (默认) | 字符向量 | 字符串标量

属性：

Bold — 选择对文档元素使用粗体 [] (默认) | true 或 1 | false 或 0

属性：

Color — 文档元素颜色 [] (默认) | 字符向量 | 字符串标量

属性：

FirstLineIndent — 段落首行的缩进量 [] | 字符向量 | 字符串标量

属性：

FontFamilyName — 文本的字体系列名称 [] | 字符向量 | 字符串标量

属性：

FontSize — 文档元素的字体大小 [] (默认) | 字符向量 | 字符串标量

属性：

HAlign — 段落水平对齐 "center" | "distribute" | ... | ...

属性：

Italic — 选择使用斜体作为文档元素 [] (默认) | true 或 1 | false 或 0

属性：

OuterLeftMargin — 段落左缩进 [] | 字符向量 | 字符串标量

属性：

OutlineLevel — 段落大纲级别 [] (默认) | 整数

属性：

Strike — 文本删除线 [] (默认) | "none" | "single" | "double"

属性：

Underline — 下划线类型 [] (默认) | "single" | "none" | ...

属性：

WhiteSpace — 如何处理文本中的空白 [] (默认) | "normal" | "nowrap" | ...

StyleName — 元素的样式表定义样式的名称 [] (默认) | 字符向量 | 字符串标量

属性：

Style — 格式设定 {} (默认) | 格式对象数组

属性：

CustomAttributes — 文档元素的自定义属性 [] (默认) | mlreportgen.dom.CustomAttribute 对象数组

属性：

Parent — mlreportgen.dom.Heading1 对象的父级 文档元素对象

属性：

Children — mlreportgen.dom.Heading1 对象的子级 文档元素对象数组

属性：

Tag — mlreportgen.dom.Heading1 对象的标签 字符向量 | 字符串标量

属性：

Id — mlreportgen.dom.Heading1 对象的标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

创建三级标题

版本历史记录

另请参阅

主题

WeChat

`text` — 标题文本
字符向量 | 字符串标量

`styleName` — 文本样式
字符向量 | 字符串标量

`domObj` — 包含在标题中的 DOM 对象
`mlreportgen.dom.ExternalLink` 对象 | `mlreportgen.dom.Image` 对象 | `mlreportgen.dom.InternalLink` 对象 | `mlreportgen.dom.LinkTarget` 对象 | `mlreportgen.dom.Text` 对象

`BackgroundColor` — 背景色
`[]` (默认) | 字符向量 | 字符串标量

`Bold` — 选择对文档元素使用粗体
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

`Color` — 文档元素颜色
`[]` (默认) | 字符向量 | 字符串标量

`FirstLineIndent` — 段落首行的缩进量
`[]` | 字符向量 | 字符串标量

`FontFamilyName` — 文本的字体系列名称
`[]` | 字符向量 | 字符串标量

`FontSize` — 文档元素的字体大小
`[]` (默认) | 字符向量 | 字符串标量

`HAlign` — 段落水平对齐
`"center"` | `"distribute"` | ... | ...

`Italic` — 选择使用斜体作为文档元素
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

`OuterLeftMargin` — 段落左缩进
`[]` | 字符向量 | 字符串标量

`OutlineLevel` — 段落大纲级别
`[]` (默认) | 整数

`Strike` — 文本删除线
`[]` (默认) | `"none"` | `"single"` | `"double"`

`Underline` — 下划线类型
`[]` (默认) | `"single"` | `"none"` | ...

`WhiteSpace` — 如何处理文本中的空白
`[]` (默认) | `"normal"` | `"nowrap"` | ...

`StyleName` — 元素的样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

`Style` — 格式设定
`{}` (默认) | 格式对象数组

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

`Parent` — `mlreportgen.dom.Heading1` 对象的父级
文档元素对象

`Children` — `mlreportgen.dom.Heading1` 对象的子级
文档元素对象数组

`Tag` — `mlreportgen.dom.Heading1` 对象的标签
字符向量 | 字符串标量

`Id` — `mlreportgen.dom.Heading1` 对象的标识符
字符向量 | 字符串标量