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

expand all

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

Properties

expand all

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

Border ValueDescriptionSupported 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

Border color, specified as either:

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

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

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

Data Types: double

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

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.

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

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

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

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

Data Types: double

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.

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 for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

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.

append

Clone this table header entry.