mlreportgen.dom.BorderCollapse Class

Namespace: mlreportgen.dom

Collapse HTML table borders

Description

Specifies whether to collapse table borders. This class applies only to HTML tables.

This class is only compatible with these MATLAB^® Report Generator™ output types:

• "html"

• "html-file"

• "html-multipage" (since R2024a)

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

Creation

Description

borderCollapseObj = BorderCollapse creates an unspecified format. Nothing is inserted in the generated table markup.

borderCollapseObj = BorderCollapse(value) creates a border collapse object having the specified value.

Input Arguments

value — Specify whether to collapse border

"on" | "off"

Setting to specify whether to collapse table borders, specified as "on" to collapse or "off" to leave the table and adjacent cell borders separate.

Properties

Value — Specify whether to collapse border

[] (default) | "on" | "off"

Setting to specify whether to collapse table borders, specified as:

• "on" — to collapse the table borders.

• "off" — to leave the table and adjacent cell borders separate.

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

Collapse and Separate Table Borders

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

magicArray = magic(5);

p = Paragraph('Collapsed Borders');
append(d,p);
table = Table(magicArray);
table.Style = {Border('solid'),BorderCollapse('on')};
     for r = 1:5
         for c = 1:5
             table.entry(r,c).Style = {Border('solid')}; 
         end
     end
append(d,table);
     
p = Paragraph('Separate Borders');
append(d,p);
table = Table(magicArray);
table.Style = {Border('solid'),BorderCollapse('off')};
     for r = 1:5
         for c = 1:5
             table.entry(r,c).Style = {Border('solid')}; 
         end
     end
append(d,table);
     
close(d);
rptview(d.OutputPath,doctype);

Version History

Introduced in R2014b