mlreportgen.dom.CharEntity class
Package: mlreportgen.dom
Superclasses: mlreportgen.dom.Text
Create character entity reference
Description
Create a reference to a character entity reference.
The mlreportgen.dom.CharEntity
class is a handle
class.
Creation
Description
creates a reference to a non-breaking space
( ) entity. Appending this reference to a
document inserts a non-breaking space.charEntityObj
= CharEntity()
creates a reference to the character entity
specified by charEntityObj
= CharEntity(name
)name
.
Input Arguments
name
— Character entity name
character vector
Entity name must be listed at https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references.
n
— Number of character entities to use
integer
Number of character entities to use, specified as an integer.
Data Types: uint16
Properties
BackgroundColor
— Background color
[]
(default) | character vector | string scalar
Background 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
.
Setting the BackgroundColor
property adds a corresponding
mlreportgen.dom.BackgroundColor
format object to the
Style
property. Setting the
BackgroundColor
property to an empty value
removes the object.
Example: 'blue'
Example: '#0000ff'
Bold
— Option to use bold for number
logical value
To make text bold, set this property to
true
or 1
.
If this property is empty and the
StyleName
property for this
document element specifies a style sheet style,
the weight of the number is determined by that
style. Setting the Bold
property adds a corresponding
mlreportGen.dom.Bold
format
object to the Style
property of
this document element. Removing the
Bold
property setting removes
the object.
Data Types: logical
Color
— Text color
[]
(default) | character vector | string scalar
Text 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
.
Setting the Color
property adds a corresponding
mlreportgen.dom.Color
format object to the
Style
property. Setting the
Color
property to an empty value removes the
object.
Example: 'blue'
Example: '#0000ff'
Content
— Text contained by this document element
character vector
Text contained by this document element, specified as a character vector.
CustomAttributes
— Custom attributes of document element
array of mlreportgen.dom.CustomAttribute
objects
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.
FontFamilyName
— Name of font family for text
[]
| character vector | string scalar
Name of a font family to use for text, specified as a character vector or string scalar.
Setting the FontFamilyName
property adds a corresponding
mlreportgen.dom.FontFamily
format object to the
Style
property. Setting the FontFamilyName
property is the same as setting the FontName
property of an
mlreportgen.dom.FontFamily
object. Setting the
FontFamilyName
property to an empty value removes the
object.
To specify substitutions for the font, do not specify the font family by setting this
property. Instead create and add an mlreportgen.dom.FontFamily
object
to the Style
property.
Example: 'Courier New'
FontSize
— Font size
character vector
If you need to specify substitutions for
this font, do not set this property. Instead
create and add an
mlreportgen.dom.FontFamily
object to the Style
property of
this document element.
Setting the FontSize
property adds a corresponding
mlreportGen.dom.FontSize
format
object to the Style
property
for this document element. Removing the
FontSize
property setting
removes the object.
Font size, specified as a character vector
in the form valueUnits
.
Units
is an abbreviation for
the units. Use one of these abbreviations for the
units for the font size.
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
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
Italic
— Option to use italics for number
logical value
To use italics for a number, set this
property to true
. If this
property is empty and the
StyleName
property for this
document element specifies a style sheet style,
the slant of the number is determined by that
style. Setting the Italic
property adds a corresponding
mlreportGen.dom.Italic
format
object to the Style
property of
this document element. Removing the
Italic
property setting removes
the object.
Data Types: logical
Name
— Name of character entity
character vector
The name is a character entity listed in https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references.
Data Types: logical
Repeat
— Number of times to repeat character entity
numeric value
Number of times to repeat character entity, specified as a numeric value.
Data Types: double
Strike
— Text strikethrough
[] (default) | 'none'
| 'single'
| 'double'
Text strikethrough, specified as one of these values:
'none'
— No strikethrough'single'
— Single line'double'
— Double line (for Word reports only)
Setting the Strike
property adds a corresponding
mlreportgen.dom.Strike
format object to the
Style
property for this document element. Setting the
Strike
property to an empty value removes the object.
Style
— Number formatting
array of format objects
An array of format objects that specifies the format for the number.
StyleName
— Style for number
character vector
The style specified by
styleName
must be defined in
the template used to create the document element
to which this number is appended.
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
Underline
— Type of underline
[]
(default) | 'single'
| 'none'
| ...
Type of underline, specified as one of the values in this table.
Underline value | Description | Supported Output Types |
---|---|---|
| Single line | All |
| Underline all characters except spaces | Word |
| Double line | Word |
| Thick line | Word |
| Dotted line | Word |
| Thick dotted line | Word |
| Dashed line | Word |
| Line with heavy dashes | Word |
| Line with long dashes | Word |
| Line with heavy long dashes | Word |
| Dot-dash line | Word |
| Heavy dash-dot line | Word |
| Dot-dot-dash line | Word |
| Line with heavy dashes with two dots between the dashes | Word |
| Wavy line | Word |
| Heavy wavy | Word |
| Double wavy line | Word |
| No underline | All |
Setting the Underline
property adds a corresponding
mlreportgen.dom.Underline
format object to the
Style
property. Setting the Underline
property
to an empty value removes the object.
To specify both the color and the type of the underline, do not set the
Underline
property. Instead, set the Style
property to include an mlreportgen.dom.Underline
format object that
specifies the underline type and color.
WhiteSpace
— How to treat white space in text
[]
(default) | 'normal'
| 'nowrap'
| ...
How to treat white space in text, specified as one of the values in this table.
Value | Description | Supported Output Types |
---|---|---|
| For HTML and PDF, this value removes spaces at the beginning and the end of text. Multiple spaces in the text collapse to a single space. For Word, this value removes spaces at the beginning and end of text. | All |
| Sequences of white space collapse into a single white space. Text never wraps to the next line. | HTML |
| Preserves white space. Text wraps only on line breaks. Acts
like the | HTML and PDF |
| Sequences of white space collapse into a single white space. Text wraps when necessary and on line breaks. | HTML and PDF |
| Preserves white space. Text wraps when necessary and on line breaks. | HTML and PDF |
| Same as 'pre'. | All |
Setting the WhiteSpace
property adds a corresponding mlreportgen.dom.WhiteSpace
format object to the Style
property. Setting the WhiteSpace
property to an empty value removes
the object.
Methods
Examples
Append a British Pound Sign
import mlreportgen.dom.*; doctype = 'html'; d = Document('test',doctype); p = Paragraph(CharEntity('pound')); append(d,p); append(p,'3'); close(d); rptview('test',doctype);
Append Two Nonbreaking Spaces
import mlreportgen.dom.*; doctype = 'html'; d = Document('test',doctype); p = Paragraph('Some text'); append(d,p); ce = CharEntity('nbsp',5); append(p,ce); append(p,'more text after five blank spaces'); close(d); rptview('test',doctype);
Version History
Introduced in R2014b
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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)