mlreportgen.dom.TableHeaderEntry class
Package: mlreportgen.dom
Superclasses: mlreportgen.dom.TableEntry
Entry in table header
Description
Specifies 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
.
The mlreportgen.dom.TableHeaderEntry
class is a handle
class.
Creation
Description
creates an empty table header entry.entryObj
= TableHeaderEntry()
Properties
Border
— Type of border to draw
'solid'
| 'single'
| 'dashed'
| 'none'
| ...
Type of border to draw, specified as one of the values in the table.
Border Value | Description | Supported Output Types |
---|---|---|
| Dashed line | All output types |
| Line with alternating diagonal dashes and dot | Word |
| Dashed line with a small gap between dashes | Word |
| Dotted line | All output types |
| Line with alternating dots and dashes | Word |
| Line with alternating double dots and a dash | Word |
| Double line | All output types |
| Double wavy line | Word |
| 3-D effect grooved line | HTML and PDF |
| No line The | HTML and PDF |
| 3-D effect line | All output types |
| No line The | All output types |
| 3-D effect line | All output types |
| 3-D effect ridged line | HTML and PDF |
| Single line | Word |
| Single line | HTML and PDF |
| Thick line | Word |
| Dashed line with alternating thick and thin dashes with a large gap | Word |
| Dashed line with alternating thick and thin dashes with a medium gap | Word |
| Dashed line with alternating thick and thin dashes with a small gap | Word |
| Dashed line with alternating thin and thick dashes with a medium gap | Word |
| Dashed line with alternating thin and thick dashes, with a medium gap | Word |
| Dashed line with alternating thin and thick dashes with a small gap | Word |
| Dashed line with alternating thin and thick dashes with a large gap | Word |
| Dashed line with alternating thin and thick dashes with a medium gap | Word |
| Dashed line with alternating thin and thick dashes with a small gap | Word |
| Embossed effect line | Word |
| Engraved effect line | Word |
| Triple line | Word |
| Wavy line | Word |
BorderColor
— Border color
character vector
Border color, specified as either:
Name of a color. The name must be a CSS color name. See https://www.w3.org/wiki/CSS/Properties/color/keywords.
A hexadecimal RGB (truecolor) value as
#RRGGBB
. For example,#0000ff
is a shade of blue.
BorderWidth
— Table border width
character vector
Table border width, specified in the form valueUnits
,
where Units
is an abbreviation for the units. Valid
abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Children
— Children of document element
array of DOM objects
Children of this document element, specified as an array of DOM objects. This property is read-only.
ColSpan
— Number of table columns spanned by table entry
double
Number of table columns spanned by the table entry, specified as a double.
Data Types: double
CustomAttributes
— Custom attributes for document element
array of mlreportgen.doc.CustomAttribute
objects
The custom attributes must be supported by the output type of the document to which this document element is appended.
Id
— ID for this document element
character vector | string scalar
ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
Hyphenation
— Type of hyphenation
false
| true
| '-'
| ' '
Type of hyphenation, specified as one of these values:
true
— Enables hyphenation and uses'-'
for the hyphenation character.'-'
— Enables hyphenation and uses'-'
for the hyphenation character.' '
— Enables hyphenation and uses a space (' '
) for the hyphenation characterfalse
— Disables hyphenation.
InnerMargin
— Inner margin (padding) around entry
character vector
Inner margin in the form valueUnits
where
Units
is an abbreviation for the units. Valid
abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Parent
— Parent of document element
DOM object
Parent of this document element, specified as a DOM object. This property is read-only.
Attributes:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
RowSpan
— Number of table rows spanned by table entry
double
Number of table rows spanned by the table entry, specified as a double.
Data Types: double
Style
— Format for table
array of format objects
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.
StyleName
— Style in document or document part style sheet
character vector
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
— Tag for this document element
character vector | string scalar
Tag for this document element, specified as a character vector or string scalar.
The DOM 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. Specifying your own tag value can
help you to identify where an issue occurred during document generation.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
VAlign
— Vertical alignment table cell content
'top'
| 'bottom'
| 'middle'
Vertical alignment table cell content, specified as one of these values:
'top'
'bottom'
'middle'
Methods
Version History
Introduced in R2014b
MATLAB-Befehl
Sie haben auf einen Link geklickt, der diesem MATLAB-Befehl entspricht:
Führen Sie den Befehl durch Eingabe in das MATLAB-Befehlsfenster aus. Webbrowser unterstützen keine MATLAB-Befehle.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)