主要内容

本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.dom.Border 类

命名空间: mlreportgen.dom

表边框属性

描述

使用 mlreportgen.dom.Border 类中的对象来指定表边框。

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

创建对象

描述

borderObj = mlreportgen.dom.Border 创建一个属性为空的边框。

borderObj = mlreportgen.dom.Border(style) 创建一个边框,并将 Style 属性设置为 style

borderObj = mlreportgen.dom.Border(style,color) 还指定了所有边框段的默认颜色,并将 Color 属性设置为 color

borderObj = mlreportgen.dom.Border(style,color,width) 还指定了所有边框段的默认宽度,并将 Width 属性设置为 width

示例

输入参量

全部展开

要绘制的边框类型,指定为表中的值之一。此参量设置 Style 属性。

边框样式描述支持在 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.TableHeaderEntrymlreportgen.dom.TableEntrymlreportgen.dom.HorizontalRule 对象的 Style 属性时,报告器不支持此属性的 "inset""outset" 样式。

边框颜色,指定为字符向量或字符串标量,其中包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值

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

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

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

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

此参量设置 Color 属性。

边框宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

此参量设置 Width 属性。

注意

Microsoft Word 具有额外的边框宽度限制:

  • Microsoft 字符将边框的宽度限制在 0.25pt6pt 的范围内。超出范围宽度分配会根据您选择的边框样式触发警告或错误消息。

  • 除了范围限制外,这些边框样式还具有以下额外限制:

    • "dashdotstroked": 3pt

    • "doublewave": 0.75pt

    • "thinthickthinmediumgap": 0.25–4.5pt

    • "thinthickthinsmallgap": 1.5–6pt

    • "threedemboss": 0.75–6pt

    • "threedengrave": 0.75–6pt

    • "triple": 0.5–3pt

    • "wave": 0.75–1.5pt

属性

全部展开

边框段的默认样式,指定为 style 输入参量中的表中的值之一。

示例: "3pt" 指定三磅。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

边框段的默认颜色,指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量

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

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

边框宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: string | char

顶边段样式,指定为 style 输入参量表中的值之一。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: string | char

顶部边框段的颜色,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写

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

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

顶部边框段的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

左边框段样式,指定为 style 输入参量表中的值之一。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: string | char

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

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

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

左边框段的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

底部边框段样式,指定为 style 输入参量表中的值之一。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: string | char

底部边框段的颜色,指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量

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

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

底部边框段的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

右边界段样式,指定为 style 输入参量表中的值之一。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: string | char

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

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

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

右边框段的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个计量单位的缩写。例如,"3pt" 指定三磅。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如,"5" 指定 5 像素。

示例: "3pt" 指定三磅。

属性:

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

示例

全部折叠

import mlreportgen.dom.*;
doctype = "html";
d = Document("test",doctype);
t = Table(magic(5));
t.Style = {Border("inset","crimson","6pt"),Width("50%")};
t.TableEntriesInnerMargin = "6pt";
append(d,t);
close(d);
rptview("test",doctype);

本示例演示了如何使用 mlreportgen.dom.Border 对象为表添加顶部边框。

导入 DOM API 命名空间。

import mlreportgen.dom.*;

创建 PDF 文档。

d = Document("myReport","pdf");

创建一个表。

t = Table(magic(3));

创建一个不包含任何行内容的 Border 对象。然后,指定顶部边框为实线。将该对象应用到表中。

border = Border("none");
border.TopStyle = "solid";
t.Style = [t.Style {border}];

将该表添加到文档中,并查看报告。

append(d,t);
close(d);
rptview(d);

版本历史记录

在 R2014b 中推出