mlreportgen.dom.TableHeaderEntry Class

Namespace: mlreportgen.dom
Superclasses: mlreportgen.dom.TableEntry

Entry in table header

Description

Use an object of the mlreportgen.dom.TableHeaderEntry class to specify 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.

To see what DOM objects you can append an mlreportgen.dom.TableHeaderEntry object to, see Append mlreportgen.dom.Heading object to DOM class object.

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

Creation

Description

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

Properties

Border — Type of border to draw

[] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

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

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

BorderColor — Border color

[] (default) | character vector | string scalar

Border color, 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

BorderWidth — Table border width

[] (default) | character vector | string scalar | ...

Table border width, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. 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: "2pt"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ColSpan — Number of table columns spanned by table entry

double

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

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

InnerMargin — Inner margin (padding) around entry

character vector

Inner margin, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. 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.

RowSpan — Number of table rows spanned by table entry

double

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: double

VAlign — Vertical alignment table cell content

"top" | "bottom" | "middle"

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

• "top"

• "bottom"

• "middle"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Name of stylesheet-defined style

[] (default) | character vector | string scalar

Name of stylesheet-defined style, specified as a character vector or string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, see Templates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | cell array of DOM format objects

Format specification for this document element object, specified as a cell array of DOM format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this document element object are ignored.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

Custom attributes of the document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of this object

document element object

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

array of document element objects

Children of this object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

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

Methods

Public Methods

Method	Purpose
append	appendedContent = append(classObj,textContent) appends text, textContent, to the class object, classObj. appendedContent = append(classObj,textContent,styleName) appends text using the style, styleName. Use a style defined in the style sheet of the template of the document you append content to. appendedContent = append(classObj,contentToAppend) appends a DOM or MATLAB object, contentToAppend, to the class object. Input Arguments classObj — Class object to append content to, specified as an mlreportgen.dom.TableHeaderEntry object. textContent — Text to append, specified as a character vector or string scalar. styleName — Name of style sheet, specified as a character vector or string scalar. Specifying this argument sets the StyleName property of the appendedContent object to styleName. contentToAppend — Content to append, specified as a DOM or MATLAB object. Return Values appendedContent — Appended content, returned as a DOM object. To see a list of the DOM class objects and MATLAB data types you can use as the classObj argument, see Append content to mlreportgen.dom.TableHeaderEntry object. For more information, see the equivalent append method from the mlreportgen.dom.Document class.
clone	copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.TableHeaderEntry object specified by soureceObj. The copy includes the children of the source object, but not the parent. Note Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document. Input Arguments soureceObj — Object to clone, specified as an mlreportgen.dom.TableHeaderEntry object Return Values copiedObj— Object copy, returned as an mlreportgen.dom.TableHeaderEntry object For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

More About

Append content to mlreportgen.dom.TableHeaderEntry object

You can append these DOM objects to an mlreportgen.dom.TableHeaderEntry object:

• mlreportgen.dom.CharEntity

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.EmbeddedObject

• mlreportgen.dom.ExternalLink

• mlreportgen.dom.FormalTable

• mlreportgen.dom.Heading

• mlreportgen.dom.Heading1

• mlreportgen.dom.Heading2

• mlreportgen.dom.Heading3

• mlreportgen.dom.Heading4

• mlreportgen.dom.Heading5

• mlreportgen.dom.Heading6

• mlreportgen.dom.HorizontalRule

• mlreportgen.dom.HTML

• mlreportgen.dom.HTMLFile

• mlreportgen.dom.Image

• mlreportgen.dom.InternalLink

• mlreportgen.dom.LineBreak (PDF, Word)

• mlreportgen.dom.MATLABTable

• mlreportgen.dom.Number

• mlreportgen.dom.NumPages (PDF, Word)

• mlreportgen.dom.OrderedList

• mlreportgen.dom.Page (PDF, Word)

• mlreportgen.dom.PageRef (PDF, Word)

• mlreportgen.dom.Paragraph

• mlreportgen.dom.Preformatted

• mlreportgen.dom.RawText

• mlreportgen.dom.StyleRef (PDF, Word)

• mlreportgen.dom.Table

• mlreportgen.dom.TemplateHole

• mlreportgen.dom.Text

• mlreportgen.dom.UnorderedList

You can append these MATLAB data types to an mlreportgen.dom.TableHeaderEntry object:

• character array — Appends and returns a mlreportgen.dom.Text object

• string scalar — Appends and returns a mlreportgen.dom.Text object

Append mlreportgen.dom.TableHeaderEntry object to DOM class object

You can append an mlreportgen.dom.TableHeaderEntry object to these DOM class objects:

• mlreportgen.dom.CustomElement

• mlreportgen.dom.TableRow

Version History

Introduced in R2014b