mlreportgen.dom.Border Class

Namespace: mlreportgen.dom

Table border properties

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

Input Arguments

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, hexadecimal RGB value, or decimal RGB value.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

This argument sets the Color property.

width — Width of border

character vector | string scalar

Width of the border, 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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

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

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:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Color — Default color of border segments

[] (default) | character vector | string scalar

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

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Width — Width of border

[] (default) | string scalar | character vector

Width of the border, 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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

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:

GetAccess	public
SetAccess	public
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 number followed by an abbreviation for a unit of measurement.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

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:

GetAccess	public
SetAccess	public
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, hexadecimal RGB value, or decimal RGB value.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

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:

GetAccess	public
SetAccess	public
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, hexadecimal RGB value, or decimal RGB value.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

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:

GetAccess	public
SetAccess	public
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, hexadecimal RGB value, or decimal RGB value.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color value	Use the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "3pt" specifies three points.

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

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

Examples

Format Table Borders

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

Create Table with Top Border

This example shows how to use an mlreportgen.dom.Border object to add top border to a table.

Import the DOM API namespace.

import mlreportgen.dom.*;

Create a PDF document.

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

Create a table.

t = Table(magic(3));

Create a Border object with no lines. Then, specify that the top border is a solid line. Apply the object to the table.

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

Add the table to document and view the report.

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

Version History

Introduced in R2014b