mlreportgen.dom.TableEntry 类

命名空间: mlreportgen.dom

表条目

全页展开

描述

指定表条目的内容和样式。

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

创建对象

描述

entryObj = TableEntry 创建一个空表条目。

entryObj = TableEntry(text) 使用指定的文本创建一个表条目。构造函数创建一个文本对象并将其追加到表条目。在 Microsoft^® Word 和 PDF 输出中，表条目中的文本被包装在段落中，因为 Word 和 PDF 不允许表条目中的文本不换行。在 HTML 输出中，文本不会换行到段落中。

entryObj = TableEntry(text,styleName) 使用指定样式创建包含指定文本的表条目。

entryObj = TableEntry(domObj) 创建一个包含 domObj 的表项，其中 domObj 是 DOM 对象，例如 mlreportgen.dom.Paragraph 对象。

输入参量

全部展开

`text` — 表条目文本
字符串标量 | 字符向量

表条目的文本，指定为字符向量或字符串标量。

数据类型: char | string

`textObj` — 包含表条目文本的文本对象
`mlreportgen.dom.Text` 对象

表条目的文本，指定为 mlreportgen.dom.Text 对象。

`styleName` — 表样式
字符向量

styleName 指定的样式必须在追加此表的文档的模板中定义。

`domObject` — 表中要包含的对象
DOM 对象

要包含在表中的对象，指定为以下 DOM 对象之一：

mlreportgen.dom.Paragraph
mlreportgen.dom.Text（包括 CharEntity）
mlreportgen.dom.Image
mlreportgen.dom.Table
mlreportgen.dom.OrderedList
mlreportgen.dom.UnorderedList
mlreportgen.dom.CustomElement

属性

全部展开

`Border` — 绘制边框的类型
`[]` (默认) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

要绘制的边框类型，指定为以下值之一：

边框样式	描述	支持在 Microsoft Word 中使用。	支持 HTML 和 PDF
`"dashed"`	虚线	是	是
`"dashdotstroked"`	斜划线和点交替出现的线	是	是
`"dashsmallgap"`	划线之间有小间隙的虚线	是	是
`"dotted"`	点线	是	是
`"dotdash"`	点划线交替出现的线	是	否
`"dotdotdash"`	双点和划线交替出现的线	是	否
`"double"`	双线	是	是
`"doublewave"`	双波浪线	是	否
`"groove"`	三维效果凹槽线	否	是
`"hidden"`	无线条当存在冲突的边框样式时，`"hidden"` 边框样式将优先于冲突的边框样式，导致不显示边框线。	否	是
`"inset"`	三维效果线	否	是
`"none"`	无线条当边框样式发生冲突时，冲突的边框样式将优先于 `"none"`，从而导致冲突的边框样式显示出来。	是	是
`"outset"`	三维效果线	是	是
`"ridge"`	三维效果脊状线	否	是
`"single"`	单线	是	是
`"solid"`	单线	否	是
`"thick"`	粗线	是	否
`"thickthinlargegap"`	粗划线和细划线交替，间隙较大	是	否
`"thickthinmediumgap"`	粗划线和细划线交替，间隙适中	是	否
`"thickthinsmallgap"`	粗划线和细划线交替，间隙较小	是	否
`"thinthicklargegap"`	细划线和粗划线交替，间隙较大	是	否
`"thinthickmediumgap"`	细划线和粗划线交替，间隙适中	是	否
`"thinthicksmallgap"`	细划线和粗划线交替，间隙较小	是	否
`"thinthickthinlargegap"`	细划线和粗划线交替，间隙较大	是	否
`"thinthickthinmediumgap"`	细划线和粗划线交替，间隙适中	是	否
`"thinthickthinsmallgap"`	细划线和粗划线交替，间隙较小	是	否
`"threedemboss"`	浮雕效果线	是	否
`"threedengrave"`	雕刻效果线	是	否
`"triple"`	三线	是	否
`"wave"`	波浪线	是	否

注意

对于 Microsoft Word 报告，当您将 mlreportgen.dom.Border 对象分配给 mlreportgen.dom.TableHeaderEntry、mlreportgen.dom.TableEntry 或 mlreportgen.dom.HorizontalRule 对象的 Style 属性时，报告器不支持此属性的 "inset" 或 "outset" 样式。

属性：

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

`BorderColor` — 边框颜色
`[]` (默认) | 字符向量 | 字符串标量

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

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

示例: "blue"

示例: "#0000ff"

属性：

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

数据类型: char | string

`BorderWidth` — 表边框宽度
`[]` (默认) | 字符向量 | 字符串标量 | ...

表边框宽度，指定为字符向量或字符串标量，其中包含一个数字后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

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

示例: "2pt"

属性：

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

数据类型: char | string

`ColSpan` — 表条目跨越的表列数
双精度值

表条目跨越的表列数，指定为双精度数。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: double

`InnerMargin` — 条目周围的内边距（填充）
字符向量 | 字符串标量

内边距，指定为字符向量或字符串标量，包含一个数字，后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

不使用缩写 - 像素
px - 像素
cm - 厘米
in - 英寸
mm - 毫米
pc - 派卡
pt - 磅

示例: "5px"

注意

设置此属性会将 InnerMargin 格式追加到此表条目的样式格式数组。

属性：

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

数据类型: char

`RowSpan` — 表条目跨越的表行数
双精度值

表条目所跨越的表行数，指定为双精度数。

属性：

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

数据类型: double

`VAlign` — 垂直对齐表单元格内容
`"top"` | `"bottom"` | `"middle"`

垂直对齐表单元格内容，指定为以下值之一：

"top"
"bottom"
"middle"

属性：

`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`

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

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

属性：

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

`Parent` — 此对象的父对象
文档元素对象

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

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

`Children` — 此对象的子对象
文档元素对象数组

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

属性：

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

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

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

属性：

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

数据类型: char | string

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

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

属性：

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

数据类型: char | string

方法

全部展开

公共方法

使用 TableEntry.append 和 TableEntry.clone 方法的方式与使用 Paragraph.append 和 Paragraph.clone 的方式相同。

方法	用途
`append`	将文本、段落、图像、表和其他元素追加到此表条目。在 Microsoft Word 和 PDF 输出中，表条目中的文本被包装在段落中，因为 Word 和 PDF 不允许表条目中的文本不换行。在 HTML 输出中，文本不会换行到段落中。
`clone`	克隆此表条目。

方法

用途

append

将文本、段落、图像、表和其他元素追加到此表条目。

在 Microsoft Word 和 PDF 输出中，表条目中的文本被包装在段落中，因为 Word 和 PDF 不允许表条目中的文本不换行。在 HTML 输出中，文本不会换行到段落中。

clone

克隆此表条目。

提示

要指定表中所有表项的格式，请调整 mlreportgen.dom.Table 或 mlreportgen.dom.FormalTable 对象的 TableEntriesStyle 属性。例如，您可以设置边框格式。

import mlreportgen.dom.*
t = Table(magic(5));
t.TableEntriesStyle = {Border("solid","black","1")};

为 mlreportgen.dom.TableEntry 对象设置的属性优先于 mlreportgen.dom.TableEntriesStyle 格式的对象。

版本历史记录

在 R2014a 中推出

另请参阅

主题

创建非正式表

mlreportgen.dom.TableEntry 类

描述

创建对象

描述

输入参量

text — 表条目文本 字符串标量 | 字符向量

textObj — 包含表条目文本的文本对象 mlreportgen.dom.Text 对象

styleName — 表样式 字符向量

domObject — 表中要包含的对象 DOM 对象

属性

Border — 绘制边框的类型 [] (默认) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

属性：

BorderColor — 边框颜色 [] (默认) | 字符向量 | 字符串标量

属性：

BorderWidth — 表边框宽度 [] (默认) | 字符向量 | 字符串标量 | ...

属性：

ColSpan — 表条目跨越的表列数 双精度值

属性：

InnerMargin — 条目周围的内边距（填充） 字符向量 | 字符串标量

属性：

RowSpan — 表条目跨越的表行数 双精度值

属性：

VAlign — 垂直对齐表单元格内容 "top" | "bottom" | "middle"

属性：

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

属性：

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

属性：

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

属性：

Parent — 此对象的父对象 文档元素对象

属性：

Children — 此对象的子对象 文档元素对象数组

属性：

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

属性：

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

属性：

方法

公共方法

提示

版本历史记录

另请参阅

主题

`text` — 表条目文本
字符串标量 | 字符向量

`textObj` — 包含表条目文本的文本对象
`mlreportgen.dom.Text` 对象

`styleName` — 表样式
字符向量

`domObject` — 表中要包含的对象
DOM 对象

`Border` — 绘制边框的类型
`[]` (默认) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`BorderColor` — 边框颜色
`[]` (默认) | 字符向量 | 字符串标量

`BorderWidth` — 表边框宽度
`[]` (默认) | 字符向量 | 字符串标量 | ...

`ColSpan` — 表条目跨越的表列数
双精度值

`InnerMargin` — 条目周围的内边距（填充）
字符向量 | 字符串标量

`RowSpan` — 表条目跨越的表行数
双精度值

`VAlign` — 垂直对齐表单元格内容
`"top"` | `"bottom"` | `"middle"`

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

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

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

`Parent` — 此对象的父对象
文档元素对象

`Children` — 此对象的子对象
文档元素对象数组

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

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