mlreportgen.dom.Text 类

命名空间: mlreportgen.dom

文本对象

描述

使用 mlreportgen.dom.Text 类的对象将文本包含在文档中。

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

类属性

`HandleCompatible`	`true`
`ConstructOnLoad`	`true`

创建对象

描述

textObj = mlreportgen.dom.Text 创建一个空 Text 对象。

textObj = mlreportgen.dom.Text(text) 创建一个包含指定文本的 Text 对象，并将 Content 属性设置为 text。

示例

textObj = mlreportgen.dom.Text(text,styleName) 还指定样式并将 StyleName 属性设置为 styleName。您必须在追加此 Text 对象的文档模板中的样式表中定义样式。

属性

全部展开

`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

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

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

属性：

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` — 文档元素的字体大小
`[]` (默认) | 字符向量 | 字符串标量

用于文档元素的字体大小，由数字和后跟计量单位缩写组成，指定为字符向量或字符串标量。例如，"12pt" 指定十二个点。有效的缩写是：

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

注意

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

示例: "12pt"

属性：

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

`WhiteSpace` — 文本中的空白和换行符
`[]` (默认) | `"normal"` | `"nowrap"` | ...

文本中使用的空白和换行符的类型，指定为表中的值之一。当 Document 对象的 Type 属性为 PDF 时，WhiteSpace 属性不适用。

值	描述	支持的输出类型
`"normal"`	不保留空白和换行符。	Word 和 HTML
`"nowrap"`	一系列的空白合并为一个单独的空白。文本永远不会换到下一行。	HTML
`"pre"`	保留空白。文本仅在换行处换行。作用类似于 HTML 中的 `<pre>` 设置。	HTML
`"preserve"`	保留空白。文本在必要时换行和换行。作用类似于 HTML 中的 `<pre-wrap>` 设置。	Word 和 HTML
`"pre-line"`	一系列的空白合并为一个单独的空白。文字换行。	HTML
`"pre-wrap"`	保留空白。必要时文本换行	HTML

如果您想在 MATLAB^® 浏览器中查看 HTML 输出，并且想要保留空白并仅在换行符处换行，请使用 preserve 设置而不是 pre 设置。

注意

设置 WhiteSpace 属性会将相应的 WhiteSpace 格式对象添加到 Style 属性。删除 WhiteSpace 属性设置将会删除 WhiteSpace 对象。

属性：

NonCopyable true

数据类型: string

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

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

注意

Microsoft^® Word 输出忽略样式名称。

属性：

NonCopyable true

数据类型: char | string

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

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

属性：

NonCopyable true

数据类型: cell

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

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

属性：

NonCopyable true

`Parent` — `mlreportgen.dom.Text` 对象的父级
文档元素对象

mlreportgen.dom.Text 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — `mlreportgen.dom.Text` 对象的子级
文档元素对象数组

mlreportgen.dom.Text 对象的子项，指定为文档元素对象的数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

`SetAccess`	`private`
`NonCopyable`	`true`

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

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

属性：

NonCopyable true

数据类型: char | string

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

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

属性：

NonCopyable true

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append`	将自定义元素追加到此文本对象。对 `Text` 对象使用 `append` 方法的方式与对 `Paragraph` 对象使用 `append` 方法的方式相同。
`clone`	复制此文本对象。对 `Text` 对象使用 `clone` 方法的方式与对 `Paragraph` 对象使用 `clone` 方法的方式相同。

示例

全部折叠

使用单独的文本对象设置段落文本的格式

打开实时脚本

在此示例中，您使用两个单独的 mlreportgen.dom.Text 对象来格式化一个段落，以便每段文本都可以拥有自己的样式。第一个 Text 对象对文本进行下划线和加粗。第二个 Text 对象使用默认样式。

导入 DOM API 命名空间，这样您就不必使用长而完全限定的名称。

import mlreportgen.dom.*

创建一个 Document 对象。

d = Document("mydoc","html");

创建一个 Paragraph 对象。

para = Paragraph();

为想要加粗和加下划线的文本创建一个 Text 对象。将 Text 对象追加到 Paragraph 对象，

paraTitle = Text("Results:");
paraTitle.Bold = true;
paraTitle.Underline = "single";
append(para,paraTitle);

为段落中其余文本创建一个 Text 对象，并将 Text 对象追加到 Paragraph 对象。

paraContent = Text(" Study 1");
append(para,paraContent);
append(d,para);

关闭并查看报告。

close(d);
rptview(d);

这是生成的段落：

版本历史记录

在 R2014b 中推出

另请参阅

mlreportgen.dom.Paragraph | mlreportgen.dom.CharEntity | mlreportgen.dom.CustomText

mlreportgen.dom.Text 类

描述

类属性

创建对象

描述

属性

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

FontSize — 文档元素的字体大小 [] (默认) | 字符向量 | 字符串标量

属性：

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

属性：

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

属性：

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

属性：

WhiteSpace — 文本中的空白和换行符 [] (默认) | "normal" | "nowrap" | ...

属性：

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

属性：

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

属性：

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

属性：

Parent — mlreportgen.dom.Text 对象的父级 文档元素对象

属性：

Children — mlreportgen.dom.Text 对象的子级 文档元素对象数组

属性：

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

属性：

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

属性：

方法

公共方法

示例

使用单独的文本对象设置段落文本的格式

版本历史记录

另请参阅

主题

WeChat

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

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

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

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

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

`FontSize` — 文档元素的字体大小
`[]` (默认) | 字符向量 | 字符串标量

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

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

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

`WhiteSpace` — 文本中的空白和换行符
`[]` (默认) | `"normal"` | `"nowrap"` | ...

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

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

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

`Parent` — `mlreportgen.dom.Text` 对象的父级
文档元素对象

`Children` — `mlreportgen.dom.Text` 对象的子级
文档元素对象数组

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

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