Main Content

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

mlreportgen.dom.PageBorder 类

命名空间: mlreportgen.dom

Microsoft Word 和 PDF 页面布局的页面边框

自 R2021b 起

描述

使用 mlreportgen.dom.PageBorder 类的对象为 Microsoft® Word 和 PDF 报 告指定页面边框。

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

类属性

ConstructOnLoad
true
HandleCompatible
true

有关类属性的信息,请参阅类属性

创建对象

描述

pageBorder = mlreportgen.dom.PageBorder 创建一个具有默认属性的 PageBorder 对象,其中所有段都是实线、黑色、宽度为 0.5 点,顶部和底部段距离页边距一个点,左侧和右侧段距离页边距四个点。

pageBorder = mlreportgen.dom.PageBorder(style) 指定所有边框段的默认样式,并将 Style 属性设置为 style

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

示例

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

示例

pageBorder = mlreportgen.dom.PageBorder(style,color,width,margin) 还指定所有边框段的默认边距,并将 Margin 属性设置为 margin

属性

全部展开

页面边框段的默认样式,指定为表中的值之一。

边框样式描述支持的输出类型支持 PDF
"dashed"虚线
"dashdotstroked"斜划线和点交替出现的线
"dashsmallgap"划线之间有小间隙的虚线
"dotted"点线
"dotdash"点划线交替出现的线
"dotdotdash"双点和划线交替出现的线
"double"双线
"doublewave"双波浪线
"inset"3D 效果线
"none"无边框
"outset"3D 效果线
"single"单线 
"solid"单线
"thick"粗线
"thickthinlargegap"粗划线和细划线交替,间隙较大
"thickthinmediumgap"粗划线和细划线交替,间隙适中
"thickthinsmallgap"粗划线和细划线交替,间隙较小
"thinthicklargegap"细划线和粗划线交替,间隙较大
"thinthickmediumgap"细划线和粗划线交替,间隙适中
"thinthicksmallgap"细划线和粗划线交替,间隙较小
"thinthickthinlargegap"细划线和粗划线交替,间隙较大
"thinthickthinmediumgap"细划线和粗划线交替,间隙适中
"thinthickthinsmallgap"细划线和粗划线交替,间隙较小
"threedemboss"浮雕效果线
"threedengrave"雕刻效果线
"triple"三线
"wave"波浪线

属性:

NonCopyable
true

边框段的默认颜色,指定为包含颜色名称或等效十六进制 RGB 规范的字符向量或字符串标量。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/

示例: "red"

示例: "#FF0000"

属性:

NonCopyable
true

页面边框段的默认宽度,指定为字符向量或字符串标量,由数字和后跟计量单位的缩写组成。例如,“1pt”指定一个点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

注意

Word 是否尊重 Width 设置取决于 Style 属性指定的样式。例如,Word 仅支持 wave 样式的 0.75 点和 1.5 点宽度。要查看 Word 支持的边框样式的宽度,请在 Word 中的设计选项卡上,在页面背景下,选择页面边框。选择样式下的边框,然后点击宽度列表以查看可用的宽度。

示例: "0.5pt"

属性:

NonCopyable
true

页面边框段的默认边距,指定为字符向量或字符串标量,由数字和后跟计量单位的缩写组成。例如,“10pt”指定十点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

对于 PDF 文档,边框段的边距是该段与页边距之间的空间。对于 Word 文档,边框段的边距是该段与页边距之间的空间或该段与页面边缘之间的空间,具体取决于 MeasureFrom 属性的值。

对于 Word 文档,Margin 值必须介于 0 点到 31 点之间,或者使用其他计量单位的等效值。

示例: "10pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

边框位置是从页面边缘还是页边距边缘(即文本边缘)测量,指定为 "text""pageboundary""pageboundary" 值仅适用于 Word 文档。对于 PDF 文档,页面边框总是从页边距开始测量。

如果值为 "text",则 MarginTopMarginLeftMarginBottomMarginRightMargin 属性指定边框段和页边距之间的距离。例如,在此 Word 文档中,页边距为一英寸,边框距页边距二十个点。

Arrow measuring a one-inch page margin stretches from the top page edge to the text. Another arrow for the border margin stretches between the border and the text.

如果值为 "pageboundary",则 MarginTopMarginLeftMarginBottomMarginRightMargin 属性的值指定边框与页面边缘之间的距离。例如,此 Word 文档中的边框距页面边缘 20 点:

Arrow showing a 20-point border margin stretches between the page border and the page edge.

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

页面边框是否围绕页眉区域,指定为 truefalse。当 MeasureFrom 属性设置为“文本”时,此属性适用于 PDF 文档或 Word 文档。

如果值为 true,则边框围绕标题。例如,此 Word 文档中的边框围绕着页眉:

The page header content, "This is the header", is inside the solid black border.

如果值为 false,则边框不围绕页眉。例如,此 Word 文档中的边框没有围绕页眉:

The page header content, "This is the header", is outside of the solid black border.

注意

对于具有多个节的 Word 文档,SurroundHeader 属性的 false 值或模板中的等效设置适用于文档的所有节。如果指定页面边框不围绕文档某一节的页眉,则页面边框不会围绕任何节的页眉。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

页面边框是否围绕页脚区域,指定为 truefalse。当 MeasureFrom 属性设置为“文本”时,此属性适用于 PDF 文档或 Word 文档。

如果值为 true,则边框围绕页脚。例如,此 Word 文档中的边框围绕着页脚:

The page footer content, "This is the footer", is inside the solid black border.

如果值为 false,则边框不围绕页脚。例如,此 Word 文档中的边框没有围绕页脚:

The page footer content, "This is the footer", is outside the solid black border.

注意

对于具有多个节的 Word 文档,SurroundFooter 属性的 false 值或模板中的等效设置适用于文档的所有节。如果指定页面边框不围绕文档节的页脚,则页面边框不会围绕任何节的页脚。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

页面顶部边框段的样式,指定为表中的值之一。

边框样式描述支持的输出类型支持 PDF
"dashed"虚线
"dashdotstroked"斜划线和点交替出现的线
"dashsmallgap"划线之间有小间隙的虚线
"dotted"点线
"dotdash"点划线交替出现的线
"dotdotdash"双点和划线交替出现的线
"double"双线
"doublewave"双波浪线
"inset"3D 效果线
"none"无边框
"outset"3D 效果线
"single"单线 
"solid"单线
"thick"粗线
"thickthinlargegap"粗划线和细划线交替,间隙较大
"thickthinmediumgap"粗划线和细划线交替,间隙适中
"thickthinsmallgap"粗划线和细划线交替,间隙较小
"thinthicklargegap"细划线和粗划线交替,间隙较大
"thinthickmediumgap"细划线和粗划线交替,间隙适中
"thinthicksmallgap"细划线和粗划线交替,间隙较小
"thinthickthinlargegap"细划线和粗划线交替,间隙较大
"thinthickthinmediumgap"细划线和粗划线交替,间隙适中
"thinthickthinsmallgap"细划线和粗划线交替,间隙较小
"threedemboss"浮雕效果线
"threedengrave"雕刻效果线
"triple"三线
"wave"波浪线

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

顶部边框段的颜色,指定为包含颜色名称或等效十六进制 RGB 规范的字符向量或字符串标量。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/

示例: "red"

示例: "#FF0000"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

顶部边框段的宽度,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“1pt”指定一个点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

注意

Word 是否尊重 TopWidth 设置取决于 TopStyle 属性指定的样式。例如,Word 仅支持 wave 样式的 0.75 点和 1.5 点宽度。要查看 Word 支持的边框样式的宽度,请在 Word 中的设计选项卡上,在页面背景下,选择页面边框。选择样式下的边框,然后点击宽度列表以查看可用的宽度。

示例: "1pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

顶部边框段的边距,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“10pt”指定十点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

对于 PDF 文档,边框段的边距是该段与页边距之间的空间。对于 Word 文档,边框段的边距是该段与页边距之间的空间或该段与页面边缘之间的空间,具体取决于 MeasureFrom 属性的值。

对于 Word 文档,TopMargin 值必须介于 0 点到 31 点之间,或者使用其他计量单位的等效值。

示例: "10pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

左边框段的样式,指定为表中的值之一。

边框样式描述支持的输出类型支持 PDF
"dashed"虚线
"dashdotstroked"斜划线和点交替出现的线
"dashsmallgap"划线之间有小间隙的虚线
"dotted"点线
"dotdash"点划线交替出现的线
"dotdotdash"双点和划线交替出现的线
"double"双线
"doublewave"双波浪线
"inset"3D 效果线
"none"无边框
"outset"3D 效果线
"single"单线 
"solid"单线
"thick"粗线
"thickthinlargegap"粗划线和细划线交替,间隙较大
"thickthinmediumgap"粗划线和细划线交替,间隙适中
"thickthinsmallgap"粗划线和细划线交替,间隙较小
"thinthicklargegap"细划线和粗划线交替,间隙较大
"thinthickmediumgap"细划线和粗划线交替,间隙适中
"thinthicksmallgap"细划线和粗划线交替,间隙较小
"thinthickthinlargegap"细划线和粗划线交替,间隙较大
"thinthickthinmediumgap"细划线和粗划线交替,间隙适中
"thinthickthinsmallgap"细划线和粗划线交替,间隙较小
"threedemboss"浮雕效果线
"threedengrave"雕刻效果线
"triple"三线
"wave"波浪线

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

左边框段的颜色,指定为包含颜色名称或等效十六进制 RGB 规范的字符向量或字符串标量。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/

示例: "red"

示例: "#FF0000"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

左边框段的宽度,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“1pt”指定一个点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

注意

Word 是否尊重 LeftWidth 设置取决于 LeftStyle 属性指定的样式。例如,Word 仅支持 wave 样式的 0.75 点和 1.5 点宽度。要查看 Word 支持的边框样式的宽度,请在 Word 中的设计选项卡上,在页面背景下,选择页面边框。选择样式下的边框,然后点击宽度列表以查看可用的宽度。

示例: "1pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

左边框段的边距,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“10pt”指定十点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

对于 PDF 文档,边框段的边距是该段与页边距之间的空间。对于 Word 文档,边框段的边距是该段与页边距之间的空间或该段与页面边缘之间的空间,具体取决于 MeasureFrom 属性的值。

对于 Word 文档,LeftMargin 值必须介于 0 点到 31 点之间,或者使用其他计量单位的等效值。

示例: "10pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

底部边框段的样式,指定为表中的一个值。

边框样式描述支持的输出类型支持 PDF
"dashed"虚线
"dashdotstroked"斜划线和点交替出现的线
"dashsmallgap"划线之间有小间隙的虚线
"dotted"点线
"dotdash"点划线交替出现的线
"dotdotdash"双点和划线交替出现的线
"double"双线
"doublewave"双波浪线
"inset"3D 效果线
"none"无边框
"outset"3D 效果线
"single"单线 
"solid"单线
"thick"粗线
"thickthinlargegap"粗划线和细划线交替,间隙较大
"thickthinmediumgap"粗划线和细划线交替,间隙适中
"thickthinsmallgap"粗划线和细划线交替,间隙较小
"thinthicklargegap"细划线和粗划线交替,间隙较大
"thinthickmediumgap"细划线和粗划线交替,间隙适中
"thinthicksmallgap"细划线和粗划线交替,间隙较小
"thinthickthinlargegap"细划线和粗划线交替,间隙较大
"thinthickthinmediumgap"细划线和粗划线交替,间隙适中
"thinthickthinsmallgap"细划线和粗划线交替,间隙较小
"threedemboss"浮雕效果线
"threedengrave"雕刻效果线
"triple"三线
"wave"波浪线

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

底部边框段的颜色,指定为包含颜色名称或等效十六进制 RGB 规范的字符向量或字符串标量。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/

示例: "red"

示例: "#FF0000"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

底部边框段的宽度,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“1pt”指定一个点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

注意

Word 是否尊重 BottomWidth 设置取决于 BottomStyle 属性指定的样式。例如,Word 仅支持 wave 样式的 0.75 点和 1.5 点宽度。要查看 Word 支持的边框样式的宽度,请在 Word 中的设计选项卡上,在页面背景下,选择页面边框。选择样式下的边框,然后点击宽度列表以查看可用的宽度。

示例: "1pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

底部边框段的边距,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“10pt”指定十点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

对于 PDF 文档,边框段的边距是该段与页边距之间的空间。对于 Word 文档,边框段的边距是该段与页边距之间的空间或该段与页面边缘之间的空间,具体取决于 MeasureFrom 属性的值。

对于 Word 文档,BottomMargin 值必须介于 0 点到 31 点之间,或者使用其他计量单位的等效值。

示例: "10pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

右边框段的样式,指定为表中的一个值。

边框样式描述支持的输出类型支持 PDF
"dashed"虚线
"dashdotstroked"斜划线和点交替出现的线
"dashsmallgap"划线之间有小间隙的虚线
"dotted"点线
"dotdash"点划线交替出现的线
"dotdotdash"双点和划线交替出现的线
"double"双线
"doublewave"双波浪线
"inset"3D 效果线
"none"无边框
"outset"3D 效果线
"single"单线 
"solid"单线
"thick"粗线
"thickthinlargegap"粗划线和细划线交替,间隙较大
"thickthinmediumgap"粗划线和细划线交替,间隙适中
"thickthinsmallgap"粗划线和细划线交替,间隙较小
"thinthicklargegap"细划线和粗划线交替,间隙较大
"thinthickmediumgap"细划线和粗划线交替,间隙适中
"thinthicksmallgap"细划线和粗划线交替,间隙较小
"thinthickthinlargegap"细划线和粗划线交替,间隙较大
"thinthickthinmediumgap"细划线和粗划线交替,间隙适中
"thinthickthinsmallgap"细划线和粗划线交替,间隙较小
"threedemboss"浮雕效果线
"threedengrave"雕刻效果线
"triple"三线
"wave"波浪线

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

右边框段的颜色,指定为包含颜色名称或等效十六进制 RGB 规范的字符向量或字符串标量。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/

示例: "red"

示例: "#FF0000"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

右边框段的宽度,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“1pt”指定一个点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

注意

Word 是否尊重 RightWidth 设置取决于 RightStyle 属性指定的样式。例如,Word 仅支持 wave 样式的 0.75 点和 1.5 点宽度。要查看 Word 支持的边框样式的宽度,请在 Word 中的设计选项卡上,在页面背景下,选择页面边框。选择样式下的边框,然后点击宽度列表以查看可用的宽度。

示例: "1pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

右边框段的边距,指定为字符向量或字符串标量,由数字和后跟测量单位的缩写组成。例如,“10pt”指定十点。有效的缩写是:

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

对于 PDF 文档,边框段的边距是该段与页边距之间的空间。对于 Word 文档,边框段的边距是该段与页边距之间的空间或该段与页面边缘之间的空间,具体取决于 MeasureFrom 属性的值。

对于 Word 文档,RightMargin 值必须介于 0 点到 31 点之间,或者使用其他计量单位的等效值。

示例: "10pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

NonCopyable
true

数据类型: char | string

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

属性:

NonCopyable
true

数据类型: char | string

示例

全部折叠

此示例生成一个 Microsoft Word 文档,该文档具有实心、红色、0.5 点边框,距页面边界 20 点。

pic2a.png

导入 DOM API 命名空间,这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*;

创建一个 Word 文档。

d = Document("myDocument","docx");
open(d);

创建一个 PageBorder 对象并指定边框样式、颜色和宽度。

pageBorder = PageBorder("solid","red","0.5pt");

指定边框位置相对于页面边界,并指定页面边界和边框之间的边距。

pageBorder.MeasureFrom ="pageboundary";
pageBorder.Margin = "20pt";

将与文档关联的布局的 PageBorder 属性设置为 PageBorder 对象。

d.CurrentPageLayout.PageBorder = pageBorder;

向文档添加文本。关闭并查看文档。

append(d,"The solid, red, 0.5-point border is 20 points from the page boundary.");
close(d);
rptview(d);

此示例生成一个 PDF 文档,该文档具有实心、红色、0.5 点边框,距页边距 20 点。

pic3a.png

导入 DOM API 命名空间,这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*;

创建 PDF 文档。

d = Document("myDocument","pdf");
open(d);

创建一个 PageBorder 对象并指定所有边框段的样式、颜色、宽度和边距。对于 PDF 文档,边框段的边距指定了该段与页边距之间的距离。

pageBorder = PageBorder("solid","red","0.5pt","20pt");

将与文档关联的布局的 PageBorder 属性设置为 PageBorder 对象。

d.CurrentPageLayout.PageBorder = pageBorder;

向文档添加文本。关闭并查看文档。

append(d,"The solid, red, 0.5-point border segments are twenty points from the margins.");
close(d);
rptview(d);

此示例使用报告 API 生成 Word 或 PDF 报 告,该报告的标题页有红色页面边框,报告的其他部分有蓝色页面边框。

导入报告 API 和 DOM API 包,这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*;
import mlreportgen.dom.*;

创建一份 Word 报 告,并为报告的所有页面指定实线、蓝色、0.5 磅的默认边框。对于 PDF 报 告,将 "docx" 替换为 "pdf"

rpt = Report("myreport","docx");
rpt.Layout.PageBorder = PageBorder("solid","blue","0.5pt");

创建标题页并为标题页指定实线、红色、0.5 磅的边框。将标题页追加到报告后。

tp = TitlePage("Title","My Report");
tp.Layout.PageBorder = PageBorder("solid","red","0.5pt");
append(rpt,tp);

创建一个章节并将其追加到报告中。

ch = Chapter("My Chapter");
append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

在生成的报告中,标题页具有红色边框,如标题页报告器布局所指定。

titlepageborder1.png

章节页面具有默认的蓝色边框,因为章节报告器布局未指定页面边框。

chapterpageborder1.png

版本历史记录

在 R2021b 中推出