mlreportgen.dom.Preformatted 类

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

预格式化的文本模块

描述

使用 mlreportgen.dom.Preformatted 类的对象来保留文本的空白格式。白色空间格式使用空白、换行符和等宽字体在多行上呈现文本并控制缩进。例如，使用 mlreportgen.dom.Preformatted 对象将程序代码添加到报告中。

如果您未设置 FontFamilyName 或 Whitespace 属性，DOM API 将使用报告类型的默认值（HTML、Microsoft^® Word 或 PDF），以便保留空白格式。您可以通过设置 FontFamilyName 或 Whitespace 属性来覆盖默认值。

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

类属性

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

有关类属性的信息，请参阅类属性。

创建对象

描述

preObj = mlreportgen.dom.Preformatted 创建一个空的预格式化段落。

示例

preObj = mlreportgen.dom.Preformatted(text) 创建一个包含指定文本的预格式化段落。

示例

preObj = mlreportgen.dom.Preformatted(text,styleName) 创建具有指定样式的预格式化段落。styleName 属性指定的样式必须在用于追加此段落的文档元素的模板中定义。

preObj = mlreportgen.dom.Preformatted(docElementObj) 创建一个包含 docElementObj 指定的文档元素的段落。

输入参量

全部展开

`text` — 段落文本
字符向量 | 字符串标量

段落文本，指定为字符向量或字符串标量。

`styleName` — 段落样式
字符向量 | 字符串标量

此段落的样式，指定为字符向量或字符串标量。必须在用于创建追加此段落的文档的模板中定义该样式。

`docElementObj` — 要包含在段落中的文档元素
DOM 对象

要包含在此段落中的文档元素（DOM 对象）。您可以指定这些 DOM 对象：

属性

全部展开

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

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

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

注意

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

示例: "blue"

示例: "#0000ff"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

选择对此文档元素使用粗体，指定为数值或逻辑值 1 (true) 或 0 (false)。要使文档元素变为粗体，请将 Bold 设置为 true 或 1。

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

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

文档元素对象颜色，指定为包含 CSS 颜色名称或十六进制 RGB 值的字符向量或字符串标量。

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

注意

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

示例: "blue"

示例: "#0000ff"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`FirstLineIndent` — 段落首行的缩进量
`[]` | 字符向量 | 字符串标量

本段第一行的缩进量，由数字和计量单位的缩写组成，指定为字符向量或字符串标量。例如，“0.5in”表示半英寸。有效的缩写是：

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

缩进量是本段落第一行相对于后续行的缩进量。要创建悬挂缩进（即除第一行之外的所有行都缩进），请使用负数。

注意

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

示例: "0.5in"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

注意

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

示例: "Courier New"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

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

注意

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

示例: "12pt"

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`HAlign` — 段落水平对齐
`"center"` | `"distribute"` | ... | ...

此段落相对于页边距或表单元格边框的水平对齐方式，指定为此表中的一个值。

值	描述	支持的输出类型
`"center"`	将段落居中。	全部
`"distribute"`	平等分配所有字符。	Word
`"justify"`	将段落左侧与页面或表条目的左侧对齐，将段落右侧与页面或表条目的右侧对齐。	全部
`"KashidaHigh"`	使用最宽的 Kashida 长度。 Kashida 是用于某些草书（例如阿拉伯语和波斯语）的一种对齐方式。	Word
`"KashidaLow"`	使用最短的 Kashida 长度。	Word
`"KashidaMedium"`	使用中等 Kashida 长度。	Word
`"left"`	段落左对齐。	全部
`"right"`	右对齐段落。	全部
`"ThaiDistribute"`	泰语解释。	Word

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`OutlineLevel` — 段落大纲级别
`[]` (默认) | 整数

段落的大纲级别，指定为整数。设置 OutlineLevel 属性会导致该段落包含在自动生成的大纲中，例如目录。该值指定了大纲中段落的级别。例如，若要使段落出现在大纲的顶层，请将 OutlineLevel 属性设置为 1。

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: int32

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

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

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

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

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

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

注意

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`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 属性设置为空值将删除该对象。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

如何处理文本中的空白和换行符，指定为此表中的一个值。当 WhiteSpace 对象的 Type 属性为 PDF 时，Document 属性不适用。

值	描述	支持的输出类型
`"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 属性设置为空值将删除该对象。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

注意

Microsoft Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

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

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

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

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Parent` — 此对象的父对象
文档元素对象

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — 此对象的子对象
文档元素对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — 标签
字符向量 | 字符串标量

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

`append`	将内容追加到段落
`clone`	复制段落对象

示例

全部折叠

报告中的格式代码

打开实时脚本

使用 mlreportgen.dom.Preformatted 对象格式化报告中的代码。输出中保留空白和换行符。代码的字体是等宽字体。

import mlreportgen.dom.*
import mlreportgen.report.*
rpt = Report('myReport','docx');

p = Paragraph("This is my code:");
pr = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");

add(rpt, p);
add(rpt,pr);

close(rpt);
rptview(rpt);

以下是生成的报告中的代码：

版本历史记录

在 R2020a 中推出

另请参阅

mlreportgen.dom.Preformatted 类

描述

类属性

创建对象

描述

输入参量

text — 段落文本 字符向量 | 字符串标量

styleName — 段落样式 字符向量 | 字符串标量

docElementObj — 要包含在段落中的文档元素 DOM 对象

属性

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

属性：

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

属性：

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

属性：

FirstLineIndent — 段落首行的缩进量 [] | 字符向量 | 字符串标量

属性：

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

属性：

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

属性：

HAlign — 段落水平对齐 "center" | "distribute" | ... | ...

属性：

OutlineLevel — 段落大纲级别 [] (默认) | 整数

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

Parent — 此对象的父对象 文档元素对象

属性：

Children — 此对象的子对象 文档元素对象数组

属性：

Tag — 标签 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

报告中的格式代码

版本历史记录

另请参阅

主题

`text` — 段落文本
字符向量 | 字符串标量

`styleName` — 段落样式
字符向量 | 字符串标量

`docElementObj` — 要包含在段落中的文档元素
DOM 对象

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

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

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

`FirstLineIndent` — 段落首行的缩进量
`[]` | 字符向量 | 字符串标量

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

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

`HAlign` — 段落水平对齐
`"center"` | `"distribute"` | ... | ...

`OutlineLevel` — 段落大纲级别
`[]` (默认) | 整数

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

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

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

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

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

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

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

`Parent` — 此对象的父对象
文档元素对象

`Children` — 此对象的子对象
文档元素对象数组

`Tag` — 标签
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量