mlreportgen.dom.TableEntry Class

Namespace: mlreportgen.dom

Table entry

Description

Specifies the content and style of a table entry.

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

Creation

Description

entryObj = TableEntry creates an empty table entry.

entryObj = TableEntry(text) creates a table entry using the specified text. The constructor creates a text object and appends it to the table entry. In Microsoft^® Word and PDF output, text in a table entry is wrapped in a paragraph because Word and PDF do not permit unwrapped text in table entries. In HTML output, the text is not wrapped in a paragraph.

entryObj = TableEntry(text,styleName) creates a table entry containing specified text using the specified style.

entryObj = TableEntry(domObj) creates a table entry containing domObj, where domObj is a DOM object such as a mlreportgen.dom.Paragraph object.

Input Arguments

text — Table entry text

string scalar | character vector

Text for the table entry, specified as a character vector or string scalar.

Data Types: char | string

textObj — Text object containing the text for the table entry

mlreportgen.dom.Text object

Text for the table entry, specified as an mlreportgen.dom.Text object.

styleName — Style for the table

character vector

The style specified by styleName must be defined in the template of the document to which this table is appended.

domObject — Objects to include in table

DOM object

Objects to include in the table, specified as one of these DOM objects:

• mlreportgen.dom.Paragraph

• mlreportgen.dom.Text (CharEntity included)

• mlreportgen.dom.Image

• mlreportgen.dom.Table

• mlreportgen.dom.OrderedList

• mlreportgen.dom.UnorderedList

• mlreportgen.dom.CustomElement

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

BorderColor — Border color

[] (default) | character vector | string scalar

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

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

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

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 | string scalar

Inner margin, specified as 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:

• no abbreviation — Pixels

• px — Pixels

• cm — Centimeters

• in — Inches

• mm — Millimeters

• pc — Picas

• pt — Points

Example: "5px"

Note

Setting this property appends an InnerMargin format to the Style format array of this table entry.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char

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, seeTemplates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | array of DOM format objects

Format specification for this document element object, specified as an 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

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

Use TableEntry.append and TableEntry.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 table entry. In Microsoft Word and PDF output, text in a table entry is wrapped in a paragraph because Word and PDF do not permit unwrapped text in table entries. In HTML output, the text is not wrapped in a paragraph.
clone	Clone this table entry.

Tips

To specify formatting for all table entries in a table, adjust the TableEntriesStyle property of the mlreportgen.dom.Table or mlreportgen.dom.FormalTable object. For example, you can set border formatting.

import mlreportgen.dom.*
t = Table(magic(5));
t.TableEntriesStyle = {Border("solid","black","1")};

Properties you set for a mlreportgen.dom.TableEntry object take precedence over mlreportgen.dom.TableEntriesStyle format objects.

Version History

Introduced in R2014a