Main Content

mlreportgen.dom.TableBody Class

Namespace: mlreportgen.dom

Body of formal table

expand all in page

Description

Specifies the body of a formal table

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

Properties

expand all

Style of the line that separates the columns of a table or table section, specified as a string scalar or a character vector. See the Border property for a table of valid entries.

Attributes:

NonCopyable
true

Data Types: char | string

Color of lines separating columns specified as a character vector or string scalar that consists of a CSS color name or a hexadecimal RGB value.

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

Width of the line separating table columns, specified as a character vector or string scalar that consists of a number followed by an abbreviation of a unit of measurement. Valid Units abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Example: "10pt"

Attributes:

NonCopyable
true

Data Types: char | string

Style of the lines that separate the rows of the table, specified as a character vector or string scalar.

See the description of the Border property for a description of the possible values.

Attributes:

NonCopyable
true

Data Types: char | string

Color of lines separating table rows, specified as a character vector or string scalar that consists of a CSS color name or a hexadecimal RGB value.

Example: "blue"

Example: "#0000ff"

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

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

Horizontal alignment of table entries, specified as "center", "left", or "right".

Attributes:

NonCopyable
true

Data Types: char | string

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

  • "top"

  • "middle"

  • "bottom"

Attributes:

NonCopyable
true

Data Types: char | string

The inner margin is the margin between table cell content and the cell borders 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

Attributes:

NonCopyable
true

Data Types: char | string

Style to use for the table entries, specified as a cell array of format objects.

Note

The styles specified by this property apply to the content of a table's entries and not to the entries themselves. For example, you can use this property to define the font size of a table's entries but not the type or color of the entry borders. To specify the borders, you have to set the Style property of each entry.

Note

Be careful not to inadvertently overwrite a previous setting of this property. For example, setting this table's TableEntriesHAlign property appends an HAlign format object to this property. To avoid overwriting this property, you should set this property before setting other table properties that append formats to this property.

Attributes:

NonCopyable
true

Data Types: cell

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

Attributes:

SetAccess
private
NonCopyable
true

Children of mlreportgen.dom.TableBody 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.TableBody 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.TableBody 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 R2014b

See Also

| | | | | |

Topics