mlreportgen.dom.TableHeaderEntry class

Package: mlreportgen.dom
Superclasses:

Entry in table header

Description

Specifies a table header entry.

This class is intended primarily to support HTML table creation. It is rendered in an HTML document as a th (table header cell) element. Use this element so you do not need to format a table header entry explicitly. TableHeaderEntry objects rely on the browser to render the header entry appropriately. For Microsoft^® Word and PDF output, TableHeaderEntry behaves the same as TableEntry.

Construction

entryObj = TableHeaderEntry() creates an empty table header entry.

Output Arguments

entryObj — Table header entry

mlreportgen.dom.TableHeaderEntry object

Table header entry, represented by an mlreportgen.dom.TableHeaderEntry object.

Properties

Border — Type of border to draw

character vector

Type of border to draw, specified as one of these values.

Border Value	Description	Supported Output Types
'dashed'	Dashed line	All output types
'dashdotstroked'	Line with alternating diagonal dashes and dot	Word
'dashsmallgap'	Dashed line with a small gap between dashes	Word
'dotted'	Dotted line	All output types
'dotdash'	Line with alternating dots and dashes	Word
'dotdotdash'	Line with alternating double dots and a dash	Word
'double'	Double line	All output types
'doublewave'	Double wavy line	Word
'groove'	3-D effect grooved line	HTML and PDF
'hidden'	No line See discussion below this table.	HTML and PDF
'inset'	3-D effect line	All output types
'none'	No line See discussion below this table.	All output types
'outset'	3-D effect line	All output types
'ridge'	3-D effect ridged line	HTML and PDF
'single'	Single line	Word
'solid'	Single line	HTML and PDF
'thick'	Thick line	Word
'thickthinlargegap'	Dashed line with alternating thick and thin dashes with a large gap	Word
'thickthinmediumgap'	Dashed line with alternating thick and thin dashes with a medium gap	Word
'thickthinsmallgap'	Dashed line with alternating thick and thin dashes with a small gap	Word
'thinthicklargegap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickmediumgap'	Dashed line with alternating thin and thick dashes, with a medium gap	Word
'thinthicksmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'thinthickthinlargegap'	Dashed line with alternating thin and thick dashes with a large gap	Word
'thinthickthinmediumgap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickthinsmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'threedemboss'	Embossed effect line	Word
'threedengrave'	Engraved effect line	Word
'triple'	Triple line	Word
'wave'	Wavy line	Word

BorderColor — Border color

character vector

Border color, specified as either:

• Name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

BorderWidth — Table border width

character vector

Table border width, specified in the form valueUnits, where Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Children — Children of this object

cell array of objects

This read-only property lists child elements of this object.

ColSpan — Number of table columns spanned by table entry

double

Number of table columns spanned by the table entry, specified as a double.

Data Types: double

CustomAttributes — Custom attributes for document element

array of mlreportgen.doc.CustomAttribute objects

The custom attributes must be supported by the output type of the document to which this document element is appended.

Id — ID for document element

character vector

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Hyphenation — Hyphenation character

Boolean | character vector

Type of hyphenation, specified as:

• Boolean for on or off using a hyphen as the hyphenation character

• A hyphenation character in the form of a character vector, for example, '-' for hyphen or ' ' for space

InnerMargin — Inner margin (padding) around entry

character vector

Inner margin in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Parent — Parent of document element

DOM object

This read-only property lists the parent of this document element.

RowSpan — Number of table rows spanned by table entry

double

Number of table rows spanned by the table entry, specified as a double.

Data Types: double

Style — Format for table

array of format objects

Array of format objects (such as Bold objects) that specify the format for this table.

This property overrides corresponding formats defined by the style sheet style specified by the StyleName property.

StyleName — Style in document or document part style sheet

character vector

Name of a style specified in the style sheet of the document or document part to which this table is appended

The style that specifies the appearance of this table in the output document, for formats not specified by Style property.

Tag — Tag for document element

character vector

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

VAlign — Vertical alignment table cell content

'top' | 'bottom' | 'middle'

Vertical alignment table cell content, specified as one of these values:

• 'top'

• 'bottom'

• 'middle'

Methods

Use TableHeaderEntry.append and TableHeaderEntry.clone methods the same way you use Paragraph.append and Paragraph.clone.

Method	Purpose
append	Append text, paragraphs, images, tables, and other elements to this entry.
clone	Clone this table header entry.