mlreportgen.dom.AutoNumber 类

命名空间: mlreportgen.dom

自动生成的号码

全页展开

描述

使用 mlreportgen.dom.AutoNumber 类的实例为 DOM 文档元素对象自动生成一个数值。

要了解可以将 mlreportgen.dom.AutoNumber 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.AutoNumber 对象追加到 DOM 类对象上。

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

创建对象

描述

autoObj = AutoNumber 创建一个没有指定数字流的自动生成的数字。

autoObj = AutoNumber(stream) 根据指定的编号流创建一个数字。

示例

autoObj = AutoNumber(stream,styleName) 使用指定的样式创建一个数字。

输入参量

全部展开

`stream` — 用于生成编号的编号流
字符向量

指定编号流，使用 mlreportgen.dom.AutoNumberStream 对象 StreamName 属性的值。

如果指定的流不存在，DOM 接口将创建一个具有指定名称且初始值为 0 的阿拉伯数字流。要使用具有其他属性（例如罗马数字）的流，请使用 mlreportgen.dom.Document.createAutoNumberStream 创建流。

`styleName` — 模板中定义的数字样式的名称
字符向量

模板中定义的数字样式的名称，指定为字符向量或字符串标量。styleName 指定的样式必须在用于创建追加编号的文档的模板中定义。

属性

全部展开

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

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

格式	值
CSS 颜色名称	指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值	使用格式 `"#RRGGBB"`。使用 `#` 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值	请使用格式 `"rgb(r,g,b)"`，其中 `r`、`g` 和 `b` 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 `0` 和 `255` 之间。

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

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

是否对此文档元素使用粗体，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 以粗体文本显示文档元素。
0 (false) - 以常规粗细显示文档元素。

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

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

文档元素对象颜色，指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量。

格式	值
CSS 颜色名称	指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值	使用格式 `"#RRGGBB"`。使用 `#` 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值	请使用格式 `"rgb(r,g,b)"`，其中 `r`、`g` 和 `b` 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 `0` 和 `255` 之间。

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

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

用于文本的字体系列的名称，指定为字符向量或字符串标量。要指定字体的替代，请不要通过设置此属性来指定字体系列。相反，创建一个 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

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

文档元素的字体大小，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"12pt" 指定十二磅。有效的缩写是：

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

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

示例: "12pt"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Italic` — 是否对文档元素使用斜体
`[]` (默认) | `1` (`true`) | `0` (`false`)

是否对文档元素使用斜体，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 以斜体文本显示文档元素。
0 (false) - 以直体文本显示文档元素。

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

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

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

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

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`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 属性设置为空值将删除该对象。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

如何处理文本中的空白和换行符，指定为此表中的一个值。当 WhiteSpace 对象的 Type 属性为 PDF 时，Document 属性不适用。

值	描述	支持的输出类型
`"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 属性设置为空值将删除该对象。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

注意

Microsoft Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: cell

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

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Id` — 目标标识符
字符向量 | 字符串标量

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Tag` — 标签
字符向量 | 字符串标量

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append`	`customElementObjOut = append(classObj,customElementObj)` 将 `CustomElement` 对象追加到 `mlreportgen.dom.AutoNumber` 对象。输入参量 `classObj` - 要追加自定义元素的类对象，指定为 `mlreportgen.dom.AutoNumber` 对象。 `customElementObjOut` - 追加的自定义元素，指定为 `CustomElement` 对象。返回值 `customElementObjOut` - 自定义元素对象的副本，返回时为 `CustomElement` 对象。注意您只能在 PDF 和 Word 报告中使用 `CustomElement` 对象。有关如何使用自定义元素的更多信息，请参阅 `mlreportgen.dom.CustomElement`。
`clone`	`copiedObj = clone(soureceObj)` 返回 `soureceObj` 指定的 `mlreportgen.dom.AutoNumber` 对象的副本。副本包含源对象的子级，但不包含父级。注意请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。输入参量 `soureceObj` - 要克隆的对象，指定为 `mlreportgen.dom.AutoNumber` 对象返回值 `copiedObj` - 对象副本，以 `mlreportgen.dom.AutoNumber` 对象形式返回有关详细信息，请参阅 `mlreportgen.dom.Paragraph` 类的等效方法 `clone`。

方法

用途

append

customElementObjOut = append(classObj,customElementObj) 将 CustomElement 对象追加到 mlreportgen.dom.AutoNumber 对象。

输入参量

classObj - 要追加自定义元素的类对象，指定为 mlreportgen.dom.AutoNumber 对象。
customElementObjOut - 追加的自定义元素，指定为 CustomElement 对象。

返回值

customElementObjOut - 自定义元素对象的副本，返回时为 CustomElement 对象。

注意

您只能在 PDF 和 Word 报告中使用 CustomElement 对象。有关如何使用自定义元素的更多信息，请参阅 mlreportgen.dom.CustomElement。

clone

copiedObj = clone(soureceObj) 返回 soureceObj 指定的 mlreportgen.dom.AutoNumber 对象的副本。副本包含源对象的子级，但不包含父级。

注意

请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。

输入参量

soureceObj - 要克隆的对象，指定为 mlreportgen.dom.AutoNumber 对象

返回值

copiedObj - 对象副本，以 mlreportgen.dom.AutoNumber 对象形式返回

有关详细信息，请参阅 mlreportgen.dom.Paragraph 类的等效方法 clone。

示例

全部折叠

使用自动生成的章节和表编号

打开实时脚本

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p,AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p, AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
close(d);
rptview('test',doctype);

详细信息

全部展开

将内容追加到 `mlreportgen.dom.AutoNumber` 对象

您可以将 mlreportgen.dom.CustomElement 对象追加到 mlreportgen.dom.AutoNumber 对象。

append(classObj,customElementObj);

将 `mlreportgen.dom.AutoNumber` 对象追加到 DOM 类对象上

您可以将 mlreportgen.dom.AutoNumber 对象追加到以下这些 DOM 类对象：

版本历史记录

在 R2014b 中推出

另请参阅

createAutoNumberStream | getAutoNumberStream | mlreportgen.dom.CounterInc | mlreportgen.dom.CounterReset

主题

自动编号文档内容

mlreportgen.dom.AutoNumber 类

描述

创建对象

描述

输入参量

stream — 用于生成编号的编号流 字符向量

styleName — 模板中定义的数字样式的名称 字符向量

属性

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

Italic — 是否对文档元素使用斜体 [] (默认) | 1 (true) | 0 (false)

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

Tag — 标签 字符向量 | 字符串标量

属性：

方法

公共方法

示例

使用自动生成的章节和表编号

详细信息

将内容追加到 mlreportgen.dom.AutoNumber 对象

将 mlreportgen.dom.AutoNumber 对象追加到 DOM 类对象上

版本历史记录

另请参阅

主题

`stream` — 用于生成编号的编号流
字符向量

`styleName` — 模板中定义的数字样式的名称
字符向量

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

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

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

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

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

`Italic` — 是否对文档元素使用斜体
`[]` (默认) | `1` (`true`) | `0` (`false`)

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

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

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

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

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

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

`Id` — 目标标识符
字符向量 | 字符串标量

`Tag` — 标签
字符向量 | 字符串标量

将内容追加到 `mlreportgen.dom.AutoNumber` 对象

将 `mlreportgen.dom.AutoNumber` 对象追加到 DOM 类对象上