Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.TableEntry class

Package: mlreportgen.dom
Superclasses:

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.

Construction

entryObj = TableEntry() creates an empty table entry.

entryObj = TableEntry(text) creates a table entry using the text included in the specified mlreportgen.dom.Text object.

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

expand all

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

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

Output Arguments

expand all

Table entry, returned as an mlreportgen.dom.TableEntry 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

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.

Inner margin in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

  • no abbreviation — pixels

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

  • px — pixels

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

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

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

  • 'top'

  • 'bottom'

  • 'middle'

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

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.

clone

Clone this table entry.

Was this topic helpful?