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

mlreportgen.dom.HorizontalRule 类

命名空间: mlreportgen.dom

报告内容之间的水平线

全页展开

描述

使用 mlreportgen.dom.HorizontalRule 类的实例在报告中插入一条水平线，以在视觉上将报告内容分隔开来。

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

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

创建对象

描述

horizontalRuleObj = HorizontalRule 创建一条未指定的水平线。

示例

属性

全部展开

水平线的线条样式，指定为以下值之一。

边框样式描述支持在 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

数据类型: char | string

线条颜色，指定为字符向量或字符串标量，其中包含 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 之间。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

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

示例: "5pt"

属性：

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)"，其中 r、g 和 b 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 0 和 255 之间。

注意

此属性仅适用于 HTML 报告。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

标记，指定为字符向量或字符串标量。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("horizontalRule",doctype);
p1 = Paragraph("Top content");
append(d,p1);

hr = HorizontalRule();
hr.Border = "dotted";
hr.BorderColor = "blue";
append(d,hr);

p2 = Paragraph("Bottom content");
append(d,p2);

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

详细信息

全部展开

版本历史记录

在 R2015b 中推出

全部展开