mlreportgen.dom.CharEntity 类

命名空间: mlreportgen.dom
超类: mlreportgen.dom.Text

创建角色实体引用

全页展开

描述

创建对字符实体引用的引用。

mlreportgen.dom.CharEntity 类是一个 handle 类。

创建对象

描述

charEntityObj = CharEntity 创建对不间断空格（）实体的引用。将此引用追加到文档会插入一个不间断空格。

charEntityObj = CharEntity(name) 创建对 name 指定的字符实体的引用。

示例

charEntityObj = CharEntity(name,n) 创建对 name 指定的字符实体的 n 引用，即 n 特殊字符的字符向量。

输入参量

全部展开

`name` — 角色实体名称
字符向量

实体名称必须在 https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references 列出。

`n` — 要使用的字符实体数
整数

要使用的字符实体的数量，指定为整数。

数据类型: uint16

属性

全部展开

`Name` — 角色实体名称
字符向量

该名称是 https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references 中列出的字符实体。

属性：

NonCopyable true

数据类型: char

`Content` — 该文档元素所包含的文本
`''` (默认) | 字符向量 | 字符串标量

此文档元素包含的文本，指定为字符向量或字符串标量。

属性：

NonCopyable true

数据类型: char | string

`BackgroundColor` — 背景色
`[]` (默认) | 字符向量 | 字符串标量

由 CSS 颜色名称或十六进制 RGB 值组成的背景颜色，指定为字符向量或字符串标量。

有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式，请使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色值。例如，"#0000ff" 指定蓝色。

注意

设置 BackgroundColor 属性会将 mlreportgen.dom.BackgroundColor 格式的对象添加到 Style 属性。将 BackgroundColor 属性设置为空值将删除该对象。

示例: "blue"

示例: "#0000ff"

属性：

NonCopyable true

数据类型: char | string

`Bold` — 选择对文档元素使用粗体
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

该文档元素可使用粗体显示，指定为数字或逻辑值 1 (true) 或 0 (false)。要使文档元素变为粗体，请将 Bold 设置为 true 或 1。

注意

设置 Bold 属性会将相应的 mlreportgen.dom.Bold 格式对象添加到 Style 属性。将 Bold 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: logical

`Color` — 文档元素颜色
`[]` (默认) | 字符向量 | 字符串标量

文档元素颜色由 CSS 颜色名称（请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords）或 #RRGGBB 形式的十六进制 RGB（真彩色）值组成，指定为字符向量或字符串标量。

注意

设置 Color 属性会将相应的 mlreportgen.dom.Color 格式对象添加到 Style 属性。将 Color 属性设置为空值将删除该对象。

示例: "blue"

示例: "#0000ff"

属性：

NonCopyable true

数据类型: char | string

`Italic` — 选择使用斜体作为文档元素
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

选择使用斜体作为文档元素，指定为数字或逻辑 1 (true) 或 0 (false)。要使文档元素变为斜体，请将 Italic 设置为 true 或 1。

注意

设置 Italic 属性会将相应的 mlreportgen.dom.Italic 格式对象添加到 Style 属性。将 Italic 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: logical

`Strike` — 文本删除线
`[]` (默认) | `"none"` | `"single"` | `"double"`

文本删除线，指定为以下值之一：

"none" - 无删除线
"single" - 单行
"double" - 双线（仅适用于 Word 报告）

注意

设置 Strike 属性会将相应的 mlreportgen.dom.Strike 格式对象添加到此文档元素的 Style 属性。将 Strike 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: char | string

`Underline` — 下划线类型
`[]` (默认) | `"single"` | `"none"` | ...

下划线的类型，指定为此表中的值之一。

下划线值	描述	支持的输出类型
`"single"`	单线	全部
`"words"`	所有字符都加下划线（空格除外）	Word
`"double"`	双线	Word
`"thick"`	粗线	Word
`"dotted"`	点线	Word
`"dottedHeavy"`	粗点线	Word
`"dash"`	虚线	Word
`"dashedHeavy"`	粗虚线	Word
`"dashLong"`	长虚线	Word
`"dashLongHeavy"`	粗长虚线	Word
`"dotDash"`	点划线	Word
`"dashDotHeavy"`	粗点划线	Word
`"dotDotDash"`	双点划线	Word
`"dashDotDotHeavy"`	粗划线，划线之间有两个点	Word
`"wave"`	波浪线	Word
`"wavyHeavy"`	粗波浪线	Word
`"wavyDouble"`	双波浪线	Word
`"none"`	无下划线	全部

要指定下划线的颜色和类型，请不要设置 Underline 属性。相反，设置 Style 属性以包含指定下划线类型和颜色的 mlreportgen.dom.Underline 格式对象。

注意

设置 Underline 属性会将相应的 mlreportgen.dom.Underline 格式对象添加到 Style 属性。将 Underline 属性设置为空值将删除该对象。

属性：

NonCopyable true

数据类型: char | string

`FontFamilyName` — 文本的字体系列名称
`[]` | 字符向量 | 字符串标量

用于文本的字体系列的名称，指定为字符向量或字符串标量。要指定字体的替代，请不要通过设置此属性来指定字体系列。相反，创建一个 mlreportgen.dom.FontFamily 对象并将其添加到 Style 属性。

注意

设置 FontFamilyName 属性会将相应的 mlreportgen.dom.FontFamily 格式对象添加到 Style 属性。设置 FontFamilyName 属性与设置 mlreportgen.dom.FontFamily 对象的 FontName 属性相同。将 FontFamilyName 属性设置为空值将删除该对象。

示例: "Courier New"

属性：

NonCopyable true

数据类型: char | string

`FontSize` — 字体大小
字符向量

如果需要指定此字体的替代，请不要设置此属性。而是创建并将 mlreportgen.dom.FontFamily 对象添加到此文档元素的 Style 属性。

设置 FontSize 属性会将相应的 mlreportGen.dom.FontSize 格式对象添加到此文档元素的 Style 属性。删除 FontSize 属性设置将会删除该对象。

字体大小，指定为 valueUnits 形式的字符向量。Units 是单位的缩写。使用这些缩写之一作为字体大小的单位。

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

`Repeat` — 重复字符实体的次数
数值

重复字符实体的次数，指定为数值。

数据类型: double

`WhiteSpace` — 如何处理文本中的空白
`[]` (默认) | `"normal"` | `"nowrap"` | ...

如何处理文本中的空白和换行符，指定为此表中的一个值。

值	描述	支持的输出类型
`"normal"`	对于 HTML 和 PDF，此值会删除文本开头和结尾的空白。文本中的多个空白折叠为一个空白。对于 Microsoft^® Word，此值将删除文本开头和结尾的空白。	全部
`"nowrap"`	一系列的空白合并为一个单独的空白。文本永远不会换到下一行。	HTML
`"pre"`	保留空白。文本仅在换行处换行。作用类似于 HTML 中的 `<pre>` 标签。	HTML 和 PDF
`"preserve"`	与 "pre" 相同。	全部
`"pre-line"`	一系列的空白合并为一个单独的空白。文本在必要时换行和换行。	HTML 和 PDF
`"pre-wrap"`	保留空白。文本在必要时换行和换行。	HTML 和 PDF

注意

设置 WhiteSpace 属性会将相应的 mlreportgen.dom.WhiteSpace 格式对象添加到 Style 属性。将 WhiteSpace 属性设置为空值将删除该对象。

数据类型: char | string

`StyleName` — 元素的样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了此元素在输出文档中的外观，除非由此元素的 Style 属性指定的格式覆盖。要了解有关使用样式表的更多信息，请参阅使用样式表样式。

注意

Microsoft Word 输出忽略样式名称。

属性：

NonCopyable true

数据类型: char | string

`Style` — 格式设定
`{}` (默认) | 格式对象数组

此文档元素对象的格式规范，指定为格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此元素的格式将被忽略。

属性：

NonCopyable true

数据类型: cell

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable true

`Tag` — `mlreportgen.dom.CharEntity` 对象的标签
字符向量 | 字符串标量

mlreportgen.dom.CharEntity 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable true

数据类型: char | string

`Id` — `mlreportgen.dom.CharEntity` 对象的标识符
字符向量 | 字符串标量

mlreportgen.dom.CharEntity 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable true

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append` `CharEntity.append` 的使用方式与 `ExternalLink.append` 类似。	将自定义元素追加到此角色实体。
`clone` `CharEntity.clone` 的使用方式与 `Paragraph.clone` 类似。	克隆该角色实体。

方法

用途

append

CharEntity.append 的使用方式与 ExternalLink.append 类似。

将自定义元素追加到此角色实体。

clone

CharEntity.clone 的使用方式与 Paragraph.clone 类似。

克隆该角色实体。

示例

全部折叠

追加英镑符号

打开实时脚本

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph(CharEntity('pound'));
append(d,p);
append(p,'3');

close(d);
rptview('test',doctype);

追加两个不间断空格

打开实时脚本

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);

版本历史记录

在 R2014b 中推出

另请参阅

mlreportgen.dom.Text | mlreportgen.dom.Paragraph

主题

报告格式化方法

mlreportgen.dom.CharEntity 类

描述

创建对象

描述

输入参量

name — 角色实体名称 字符向量

n — 要使用的字符实体数 整数

属性

Name — 角色实体名称 字符向量

属性：

Content — 该文档元素所包含的文本 '' (默认) | 字符向量 | 字符串标量

属性：

BackgroundColor — 背景色 [] (默认) | 字符向量 | 字符串标量

属性：

Bold — 选择对文档元素使用粗体 [] (默认) | true 或 1 | false 或 0

属性：

Color — 文档元素颜色 [] (默认) | 字符向量 | 字符串标量

属性：

Italic — 选择使用斜体作为文档元素 [] (默认) | true 或 1 | false 或 0

属性：

Strike — 文本删除线 [] (默认) | "none" | "single" | "double"

属性：

Underline — 下划线类型 [] (默认) | "single" | "none" | ...

属性：

FontFamilyName — 文本的字体系列名称 [] | 字符向量 | 字符串标量

属性：

FontSize — 字体大小 字符向量

Repeat — 重复字符实体的次数 数值

WhiteSpace — 如何处理文本中的空白 [] (默认) | "normal" | "nowrap" | ...

StyleName — 元素的样式表定义样式的名称 [] (默认) | 字符向量 | 字符串标量

属性：

Style — 格式设定 {} (默认) | 格式对象数组

属性：

CustomAttributes — 文档元素的自定义属性 [] (默认) | mlreportgen.dom.CustomAttribute 对象数组

属性：

Tag — mlreportgen.dom.CharEntity 对象的标签 字符向量 | 字符串标量

属性：

Id — mlreportgen.dom.CharEntity 对象的标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

追加英镑符号

追加两个不间断空格

版本历史记录

另请参阅

主题

WeChat

`name` — 角色实体名称
字符向量

`n` — 要使用的字符实体数
整数

`Name` — 角色实体名称
字符向量

`Content` — 该文档元素所包含的文本
`''` (默认) | 字符向量 | 字符串标量

`BackgroundColor` — 背景色
`[]` (默认) | 字符向量 | 字符串标量

`Bold` — 选择对文档元素使用粗体
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

`Color` — 文档元素颜色
`[]` (默认) | 字符向量 | 字符串标量

`Italic` — 选择使用斜体作为文档元素
`[]` (默认) | `true` 或 `1` | `false` 或 `0`

`Strike` — 文本删除线
`[]` (默认) | `"none"` | `"single"` | `"double"`

`Underline` — 下划线类型
`[]` (默认) | `"single"` | `"none"` | ...

`FontFamilyName` — 文本的字体系列名称
`[]` | 字符向量 | 字符串标量

`FontSize` — 字体大小
字符向量

`Repeat` — 重复字符实体的次数
数值

`WhiteSpace` — 如何处理文本中的空白
`[]` (默认) | `"normal"` | `"nowrap"` | ...

`StyleName` — 元素的样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

`Style` — 格式设定
`{}` (默认) | 格式对象数组

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

`Tag` — `mlreportgen.dom.CharEntity` 对象的标签
字符向量 | 字符串标量

`Id` — `mlreportgen.dom.CharEntity` 对象的标识符
字符向量 | 字符串标量