mlreportgen.dom.Border Class

Namespace: mlreportgen.dom

Table border properties

expand all in page

Description

Use an object of the mlreportgen.dom.Border class to specify table borders.

The mlreportgen.dom.Border class is a handle class.

Creation

Description

borderObj = mlreportgen.dom.Border creates a border with empty properties.

borderObj = mlreportgen.dom.Border(style) creates a border and sets the Style property to style.

borderObj = mlreportgen.dom.Border(style,color) also specifies the default color for all border segments and sets the Color property to color

borderObj = mlreportgen.dom.Border(style,color,width) also specifies the default width for all border segments and sets the Width property to width

example

Input Arguments

expand all

`style` — Type of border to draw
`"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Type of border to draw, specified as one of the values in the table. This argument sets the Style property.

Border Style	Description	Supported in Microsoft^® Word	Supported in HTML and PDF
`"dashed"`	Dashed line	yes	yes
`"dashdotstroked"`	Line with alternating diagonal dashes and dot	yes	yes
`"dashsmallgap"`	Dashed line with a small gap between dashes	yes	yes
`"dotted"`	Dotted line	yes	yes
`"dotdash"`	Line with alternating dots and dashes	yes	no
`"dotdotdash"`	Line with alternating double dots and a dash	yes	no
`"double"`	Double line	yes	yes
`"doublewave"`	Double wavy line	yes	no
`"groove"`	3-D effect grooved line	no	yes
`"hidden"`	No line When there is a conflicting border style, the `"hidden"` border style takes precedence over the conflicting border style, which results in no line displaying.	no	yes
`"inset"`	3-D effect line	no	yes
`"none"`	No line When there is a conflicting border style, the conflicting border style takes precedence over `"none"`, which results in the conflicting border style displaying.	yes	yes
`"outset"`	3-D effect line	yes	yes
`"ridge"`	3-D effect ridged line	no	yes
`"single"`	Single line	yes	yes
`"solid"`	Single line	no	yes
`"thick"`	Thick line	yes	no
`"thickthinlargegap"`	Dashed line with alternating thick and thin dashes with a large gap	yes	no
`"thickthinmediumgap"`	Dashed line with alternating thick and thin dashes with a medium gap	yes	no
`"thickthinsmallgap"`	Dashed line with alternating thick and thin dashes with a small gap	yes	no
`"thinthicklargegap"`	Dashed line with alternating thin and thick dashes with a large gap	yes	no
`"thinthickmediumgap"`	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
`"thinthicksmallgap"`	Dashed line with alternating thin and thick dashes with a small gap	yes	no
`"thinthickthinlargegap"`	Dashed line with alternating thin and thick dashes with a large gap	yes	no
`"thinthickthinmediumgap"`	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
`"thinthickthinsmallgap"`	Dashed line with alternating thin and thick dashes with a small gap	yes	no
`"threedemboss"`	Embossed effect line	yes	no
`"threedengrave"`	Engraved effect line	yes	no
`"triple"`	Triple line	yes	no
`"wave"`	Wavy line	yes	no

Note

For Microsoft Word reports, when you assign an mlreportgen.dom.Border object to the Style property of an mlreportgen.dom.TableHeaderEntry, mlreportgen.dom.TableEntry, or mlreportgen.dom.HorizontalRule object, the reporter does not support "inset" or "outset" styles for this property.

`color` — Color of border
character vector | string scalar

Color of the border, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

This argument sets the Color property.

`width` — Width of border
character vector | string scalar

Width of the border, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "3pt" specifies three points. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

This argument sets the Width property.

Note

Microsoft Word has additional border width limitations:

Microsoft Word limits the width of borders to the range of 0.25pt to 6pt. Out of range width assignments trigger a warning or error message depending on your chosen border style.
Along with the range limit, these border styles have additional limitations:
- "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

Properties

expand all

`Style` — Default style of border segments
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Default style of the border segments, specified as one of the values in the table in the style input argument.

Example: "3pt" specifies three points.

Attributes:

NonCopyable true

Data Types: char | string

`Color` — Default color of border segments
`[]` (default) | character vector | string scalar

Color of the border segments, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

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

Data Types: char | string

`Width` — Width of border
`[]` (default) | string scalar | character vector

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

Attributes:

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

Data Types: string | char

`TopStyle` — Top border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Top border segment style, specified as one of the values in the table in the style input argument.

Attributes:

NonCopyable true

Data Types: string | char

`TopColor` — Color of top border segment
`[]` (default) | character vector | string scalar

Color of the top border segment, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

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

Data Types: char | string

`TopWidth` — Width of top border segment
`[]` (default) | character vector | string scalar

Width of the top border segment, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "3pt" specifies three points. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

Attributes:

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

Data Types: char | string

`LeftStyle` — Left border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Left border segment style, specified as one of the values in the table in the style input argument.

Attributes:

NonCopyable true

Data Types: string | char

`LeftColor` — Color of left border segment
`[]` (default) | character vector | string scalar

Color of the left border segment, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

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

Data Types: char | string

`LeftWidth` — Width of left border segment
`[]` (default) | character vector | string scalar

Width of the left border segment, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "3pt" specifies three points. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

Attributes:

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

Data Types: char | string

`BottomStyle` — Bottom border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Bottom border segment style, specified as one of the values in the table in the style input argument.

Attributes:

NonCopyable true

Data Types: string | char

`BottomColor` — Color of bottom border segment
`[]` (default) | character vector | string scalar

Color of the bottom border segment, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

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

Data Types: char | string

`BottomWidth` — Width of bottom border segment
`[]` (default) | character vector | string scalar

Width of the bottom border segment, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "3pt" specifies three points. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

Attributes:

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

Data Types: char | string

`RightStyle` — Right border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

Right border segment style, specified as one of the values in the table in the style input argument.

Attributes:

NonCopyable true

Data Types: string | char

`RightColor` — Color of right border segment
`[]` (default) | character vector | string scalar

Color of the right border segment, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.
To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

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

Data Types: char | string

`RightWidth` — Width of right border segment
`[]` (default) | character vector | string scalar

Width of the right border segment, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "3pt" specifies three points. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Example: "3pt" specifies three points.

Attributes:

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

Data Types: char | string

`Id` — Object identifier
character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

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

Data Types: char | string

`Tag` — Tag
character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

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

Data Types: char | string

Examples

collapse all

Format Table Borders

Open Live Script

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);

Version History

Introduced in R2014b

mlreportgen.dom.Border Class

Description

Creation

Description

Input Arguments

style — Type of border to draw "dashed" | "dashdotstroked" | "dashsmallgap" | ...

color — Color of border character vector | string scalar

width — Width of border character vector | string scalar

Properties

Style — Default style of border segments [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

Color — Default color of border segments [] (default) | character vector | string scalar

Attributes:

Width — Width of border [] (default) | string scalar | character vector

Attributes:

TopStyle — Top border segment style [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

TopColor — Color of top border segment [] (default) | character vector | string scalar

Attributes:

TopWidth — Width of top border segment [] (default) | character vector | string scalar

Attributes:

LeftStyle — Left border segment style [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

LeftColor — Color of left border segment [] (default) | character vector | string scalar

Attributes:

LeftWidth — Width of left border segment [] (default) | character vector | string scalar

Attributes:

BottomStyle — Bottom border segment style [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

BottomColor — Color of bottom border segment [] (default) | character vector | string scalar

Attributes:

BottomWidth — Width of bottom border segment [] (default) | character vector | string scalar

Attributes:

RightStyle — Right border segment style [] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Attributes:

RightColor — Color of right border segment [] (default) | character vector | string scalar

Attributes:

RightWidth — Width of right border segment [] (default) | character vector | string scalar

Attributes:

Id — Object identifier character vector | string scalar

Attributes:

Tag — Tag character vector | string scalar

Attributes:

Examples

Format Table Borders

Version History

See Also

Topics

`style` — Type of border to draw
`"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`color` — Color of border
character vector | string scalar

`width` — Width of border
character vector | string scalar

`Style` — Default style of border segments
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`Color` — Default color of border segments
`[]` (default) | character vector | string scalar

`Width` — Width of border
`[]` (default) | string scalar | character vector

`TopStyle` — Top border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`TopColor` — Color of top border segment
`[]` (default) | character vector | string scalar

`TopWidth` — Width of top border segment
`[]` (default) | character vector | string scalar

`LeftStyle` — Left border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`LeftColor` — Color of left border segment
`[]` (default) | character vector | string scalar

`LeftWidth` — Width of left border segment
`[]` (default) | character vector | string scalar

`BottomStyle` — Bottom border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`BottomColor` — Color of bottom border segment
`[]` (default) | character vector | string scalar

`BottomWidth` — Width of bottom border segment
`[]` (default) | character vector | string scalar

`RightStyle` — Right border segment style
`[]` (default) | `"dashed"` | `"dashdotstroked"` | `"dashsmallgap"` | ...

`RightColor` — Color of right border segment
`[]` (default) | character vector | string scalar

`RightWidth` — Width of right border segment
`[]` (default) | character vector | string scalar

`Id` — Object identifier
character vector | string scalar

`Tag` — Tag
character vector | string scalar