Main Content

mlreportgen.dom.TableEntry Class

Namespace: mlreportgen.dom

Description

Specifies the content and style of a table entry.

Tip

To specify formatting for all table entries in a table, use the TableEntriesStyle property of the Table or 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 TableEntry object take precedence over TableEntriesStyle format objects.

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 an mlreportgen.dom.Paragraph object.

Input Arguments

expand all

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

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

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

Objects to include in the table, specified as a DOM object. The valid DOM objects are:

  • mlreportgen.dom.Paragraph

  • mlreportgen.dom.Text (CharEntity included)

  • mlreportgen.dom.Image

  • mlreportgen.dom.Table

  • mlreportgen.dom.OrderedList

  • mlreportgen.dom.UnorderedList

  • mlreportgen.dom.CustomElement

Properties

expand all

Type of border to draw, specified as one of the values in the table.

Border ValueDescriptionSupported Output Types

"dashed"

Dashed line

HTML, PDF, Word

"dashdotstroked"

Line with alternating diagonal dashes and dot

Word

"dashsmallgap"

Dashed line with a small gap between dashes

Word

"dotted"

Dotted line

HTML, PDF, Word

"dotdash"

Line with alternating dots and dashes

Word

"dotdotdash"

Line with alternating double dots and a dash

Word

"double"

Double line

HTML, PDF, Word

"doublewave"

Double wavy line

Word

"groove"

3-D effect grooved line

HTML, PDF

"hidden"

No line

The "none" border type also produces no line. However, conflicting borders are handled differently for "hidden" types than for "none" types. The "hidden" border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the "none" type.

HTML, PDF

"inset"

3-D effect line

HTML, PDF, Word

"none"

No line

The "hidden" border type also produces no line. However, conflicting borders are handled differently for "hidden" types than for "none" types. The "hidden" border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the "none" type.

HTML, PDF, Word

"outset"

3-D effect line

HTML, PDF, Word

"ridge"

3-D effect ridged line

HTML, PDF

"single"

Single line

Word

"solid"

Single line

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

Attributes:

NonCopyable
true

Data Types: char | string

Border color, specified as a character vector or string scalar that consists of a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a hexadecimal RGB (truecolor) value in the form #RRGGBB.

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

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

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Example: "2pt"

Attributes:

NonCopyable
true

Data Types: char | string

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

Data Types: double

Inner margin in the form valueUnits where Units is an abbreviation for the units. 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:

NonCopyable
true

Data Types: char

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

Data Types: double

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

  • 'top'

  • 'bottom'

  • 'middle'

Data Types: char | string

Style name, 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 overridden by the formats specified by the Style property of this element. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word output ignores the style name.

Attributes:

NonCopyable
true

Data Types: char | string

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:

NonCopyable
true

Custom attributes of this 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:

NonCopyable
true

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

Attributes:

SetAccess
private
NonCopyable
true

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

Attributes:

SetAccess
private
NonCopyable
true

Tag for the mlreportgen.dom.TableEntry object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for the mlreportgen.dom.TableEntry object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Methods

expand all

Version History

Introduced in R2014a